{ "name": "apigateway", "display_name": "API 网关", "description": "介绍如何使用API对API网关进行操作，包括自定义域名、限流策略等。", "domain": "other", "api_version": "2018-08-08", "endpoint": "apigateway.tencentcloudapi.com", "actions": [ { "name": "AttachPlugin", "description": "绑定插件到API上。", "status": "online", "parameters": [ { "name": "PluginId", "type": "string", "required": true, "description": "绑定的API网关插件ID。", "example": "plugin-2nuhovb7" }, { "name": "ServiceId", "type": "string", "required": true, "description": "要操作的服务ID。", "example": "service-jzo37opy" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "要操作API的环境。", "example": "release" }, { "name": "ApiIds", "type": "array", "required": true, "description": "要绑定的API列表。", "example": "['api-buz84890','api-9nb6hd46']", "item_type": "string" } ], "required": [ "PluginId", "ServiceId", "EnvironmentName", "ApiIds" ] }, { "name": "BindApiApp", "description": "本接口（BindApiApp）用于绑定应用到API。", "status": "online", "parameters": [ { "name": "ApiAppId", "type": "string", "required": true, "description": "待绑定的应用唯一 ID 。", "example": "app-kzofrjbl" }, { "name": "Environment", "type": "string", "required": true, "description": "待绑定的环境。", "example": "test" }, { "name": "ServiceId", "type": "string", "required": true, "description": "待绑定的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ApiId", "type": "string", "required": true, "description": "待绑定的API唯一ID。", "example": "api-c6piso8y" } ], "required": [ "ApiAppId", "Environment", "ServiceId", "ApiId" ] }, { "name": "BindEnvironment", "description": "本接口（BindEnvironment）用于绑定使用计划到服务或API。 用户在发布服务到某个环境中后，如果 API 需要鉴权，还需要绑定使用计划才能进行调用，此接口用户将使用计划绑定到特定环境。 目前支持绑定使用计划到API，但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划，所以对已经绑定过服务级别使用计划的环境，请先使用 服务级别使用计划降级 接口\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "UsagePlanIds", "type": "array", "required": true, "description": "待绑定的使用计划唯一 ID 列表。", "example": "[\"usagePlan-quqxvett\\r\\n\"]", "item_type": "string" }, { "name": "BindType", "type": "string", "required": true, "description": "绑定类型，取值为API、SERVICE，默认值为SERVICE。", "example": "SERVICE" }, { "name": "Environment", "type": "string", "required": true, "description": "待绑定的环境。", "example": "test" }, { "name": "ServiceId", "type": "string", "required": true, "description": "待绑定的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ApiIds", "type": "array", "required": false, "description": "API唯一ID数组，当bindType=API时，需要传入此参数。", "example": "xx", "item_type": "string" } ], "required": [ "UsagePlanIds", "BindType", "Environment", "ServiceId" ] }, { "name": "BindIPStrategy", "description": "本接口（BindIPStrategy）用于API绑定IP策略。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待绑定的IP策略所属的服务唯一ID。", "example": "service-ody35h5e" }, { "name": "StrategyId", "type": "string", "required": true, "description": "待绑定的IP策略唯一ID。", "example": "IPStrategy-0ez0c8to" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "IP策略待绑定的环境。", "example": "test" }, { "name": "BindApiIds", "type": "array", "required": true, "description": "IP策略待绑定的API列表。", "example": "[\"api-e92i2jds\\r\\n\"]", "item_type": "string" } ], "required": [ "ServiceId", "StrategyId", "EnvironmentName", "BindApiIds" ] }, { "name": "BindSecretIds", "description": "本接口（BindSecretIds）用于为使用计划绑定密钥。 将密钥绑定到某个使用计划，并将此使用计划绑定到某个服务发布的环境上，调用者方可使用此密钥调用这个服务中的 API，可使用本接口为使用计划绑定密钥。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "待绑定的使用计划唯一 ID。", "example": "usagePlan-quqxvett" }, { "name": "AccessKeyIds", "type": "array", "required": true, "description": "待绑定的密钥 ID 数组。", "example": "[\"AKIDmyE2z0gvi2p6***************\\n\"]", "item_type": "string" } ], "required": [ "UsagePlanId", "AccessKeyIds" ] }, { "name": "BindSubDomain", "description": "本接口（BindSubDomain）用于绑定自定义域名到服务。 API 网关中每个服务都会提供一个默认的域名供用户调用，但当用户想使用自己的已有域名时，也可以将自定义域名绑定到此服务，在做好备案、与默认域名的 CNAME 后，可直接调用自定义域名。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一 ID。", "example": "service-1w9ekbwo" }, { "name": "SubDomain", "type": "string", "required": true, "description": "待绑定的自定义的域名。", "example": "xxx.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "服务支持协议，可选值为http、https、http\u0026https。", "example": "http" }, { "name": "NetType", "type": "string", "required": true, "description": "网络类型，可选值为OUTER、INNER。", "example": "OUTER" }, { "name": "IsDefaultMapping", "type": "boolean", "required": true, "description": "是否使用默认路径映射，默认为 true。为 false 时，表示自定义路径映射，此时 PathMappingSet 必填。", "example": "TRUE" }, { "name": "NetSubDomain", "type": "string", "required": true, "description": "默认域名。", "example": "service-1w9ekbwo-1259027407.gz.apigw.tencentcs.com" }, { "name": "CertificateId", "type": "string", "required": false, "description": "待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http\u0026https可以选择上传。", "example": "x x" }, { "name": "PathMappingSet", "type": "array", "required": false, "description": "自定义域名路径映射，最多输入三个Environment，并且只能分别取值“test”、 ”prepub“、”release“。", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": true, "description": "路径。" }, { "name": "Environment", "type": "string", "required": true, "description": "发布环境，可选值为“test”、 ”prepub“、”release“。" } ] }, { "name": "IsForcedHttps", "type": "boolean", "required": false, "description": "是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。", "example": "TRUE" } ], "required": [ "ServiceId", "SubDomain", "Protocol", "NetType", "IsDefaultMapping", "NetSubDomain" ] }, { "name": "BuildAPIDoc", "description": "构建 API 文档", "status": "online", "parameters": [ { "name": "ApiDocId", "type": "string", "required": true, "description": "API文档ID", "example": "doc-v8tsladd" } ], "required": [ "ApiDocId" ] }, { "name": "CreateAPIDoc", "description": "创建 API 文档", "status": "online", "parameters": [ { "name": "ApiDocName", "type": "string", "required": true, "description": "API文档名称", "example": "ApiGateWay Doc" }, { "name": "ServiceId", "type": "string", "required": true, "description": "服务名称", "example": "service-2nuhovb7" }, { "name": "Environment", "type": "string", "required": true, "description": "环境名称", "example": "release" }, { "name": "ApiIds", "type": "array", "required": true, "description": "生成文档的API列表", "example": "[api-2dvasde2,api-zewq23]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] } ], "required": [ "ApiDocName", "ServiceId", "Environment", "ApiIds" ] }, { "name": "CreateApi", "description": "本接口（CreateApi）用于创建 API 接口，创建 API 前，用户需要先创建服务，每个 API 都有自己归属的服务。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API 所在的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ServiceType", "type": "string", "required": true, "description": "API 的后端服务类型。支持HTTP、MOCK、TSF、SCF、EB、TARGET、VPC、UPSTREAM、GRPC、COS、WEBSOCKET。", "example": "MOCK" }, { "name": "ServiceTimeout", "type": "integer", "required": true, "description": "API 的后端服务超时时间，单位是秒。", "example": "15" }, { "name": "Protocol", "type": "string", "required": true, "description": "API 的前端请求协议，支持HTTP和WEBSOCKET。", "example": "HTTP" }, { "name": "RequestConfig", "type": "object", "required": true, "description": "请求的前端配置。", "example": "无", "children": [ { "name": "Path", "type": "string", "required": true, "description": "path" }, { "name": "Method", "type": "string", "required": true, "description": "方法" } ] }, { "name": "ApiName", "type": "string", "required": false, "description": "用户自定义的 API 名称。", "example": "name" }, { "name": "ApiDesc", "type": "string", "required": false, "description": "用户自定义的 API 接口描述。", "example": "desc" }, { "name": "ApiType", "type": "string", "required": false, "description": "API 类型，支持NORMAL（普通API）和TSF（微服务API），默认为NORMAL。", "example": "NORMAL" }, { "name": "AuthType", "type": "string", "required": false, "description": "API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH、APP（应用认证）。默认为NONE。", "example": "NONE" }, { "name": "EnableCORS", "type": "boolean", "required": false, "description": "是否开启跨域。", "example": "false" }, { "name": "ConstantParameters", "type": "array", "required": false, "description": "常量参数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Desc", "type": "string", "required": false, "description": "常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Position", "type": "string", "required": false, "description": "常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "RequestParameters", "type": "array", "required": false, "description": "前端请求参数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "请求参数名称" }, { "name": "Desc", "type": "string", "required": false, "description": "描述" }, { "name": "Position", "type": "string", "required": false, "description": "参数位置" }, { "name": "Type", "type": "string", "required": false, "description": "参数类型" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "默认值" }, { "name": "Required", "type": "boolean", "required": false, "description": "是否必须" } ] }, { "name": "ApiBusinessType", "type": "string", "required": false, "description": "当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。", "example": "NORMAL" }, { "name": "ServiceMockReturnMessage", "type": "string", "required": false, "description": "API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。", "example": "mock" }, { "name": "MicroServices", "type": "array", "required": false, "description": "API绑定微服务列表。", "example": "无", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "微服务集群。" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "微服务命名空间。" }, { "name": "MicroServiceName", "type": "string", "required": true, "description": "微服务名称。" } ] }, { "name": "ServiceTsfLoadBalanceConf", "type": "object", "required": false, "description": "微服务的负载均衡配置。", "example": "无", "children": [ { "name": "IsLoadBalance", "type": "boolean", "required": false, "description": "是否开启负载均衡。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Method", "type": "string", "required": false, "description": "负载均衡方式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SessionStickRequired", "type": "boolean", "required": false, "description": "是否开启会话保持。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SessionStickTimeout", "type": "integer", "required": false, "description": "会话保持超时时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ServiceTsfHealthCheckConf", "type": "object", "required": false, "description": "微服务的健康检查配置。", "example": "无", "children": [ { "name": "IsHealthCheck", "type": "boolean", "required": false, "description": "是否开启健康检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RequestVolumeThreshold", "type": "integer", "required": false, "description": "健康检查阈值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SleepWindowInMilliseconds", "type": "integer", "required": false, "description": "窗口大小。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ErrorThresholdPercentage", "type": "integer", "required": false, "description": "阈值百分比。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "TargetServices", "type": "array", "required": false, "description": "target类型后端资源信息。（内测阶段）", "example": "无", "item_type": "object", "children": [ { "name": "VmIp", "type": "string", "required": true, "description": "vm ip" }, { "name": "VpcId", "type": "string", "required": true, "description": "vpc id" }, { "name": "VmPort", "type": "integer", "required": true, "description": "vm port" }, { "name": "HostIp", "type": "string", "required": true, "description": "cvm所在宿主机ip" }, { "name": "DockerIp", "type": "string", "required": false, "description": "docker ip" } ] }, { "name": "TargetServicesLoadBalanceConf", "type": "integer", "required": false, "description": "target类型负载均衡配置。（内测阶段）", "example": "0" }, { "name": "TargetServicesHealthCheckConf", "type": "object", "required": false, "description": "target健康检查配置。（内测阶段）", "example": "无", "children": [ { "name": "IsHealthCheck", "type": "boolean", "required": false, "description": "是否开启健康检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RequestVolumeThreshold", "type": "integer", "required": false, "description": "健康检查阈值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SleepWindowInMilliseconds", "type": "integer", "required": false, "description": "窗口大小。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ErrorThresholdPercentage", "type": "integer", "required": false, "description": "阈值百分比。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ServiceScfFunctionName", "type": "string", "required": false, "description": "scf 函数名称。当后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketRegisterFunctionName", "type": "string", "required": false, "description": "scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketCleanupFunctionName", "type": "string", "required": false, "description": "scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketTransportFunctionName", "type": "string", "required": false, "description": "scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceScfFunctionNamespace", "type": "string", "required": false, "description": "scf 函数命名空间。当后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceScfFunctionQualifier", "type": "string", "required": false, "description": "scf函数版本。当后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketRegisterFunctionNamespace", "type": "string", "required": false, "description": "scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketRegisterFunctionQualifier", "type": "string", "required": false, "description": "scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketTransportFunctionNamespace", "type": "string", "required": false, "description": "scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketTransportFunctionQualifier", "type": "string", "required": false, "description": "scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketCleanupFunctionNamespace", "type": "string", "required": false, "description": "scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketCleanupFunctionQualifier", "type": "string", "required": false, "description": "scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceScfIsIntegratedResponse", "type": "boolean", "required": false, "description": "是否开启响应集成。当后端类型是SCF时生效。", "example": "false" }, { "name": "IsDebugAfterCharge", "type": "boolean", "required": false, "description": "开始调试后计费。（云市场预留字段）", "example": "false" }, { "name": "IsDeleteResponseErrorCodes", "type": "boolean", "required": false, "description": "是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。", "example": "false" }, { "name": "ResponseType", "type": "string", "required": false, "description": "返回类型。", "example": "html" }, { "name": "ResponseSuccessExample", "type": "string", "required": false, "description": "自定义响应配置成功响应示例。", "example": "xxx" }, { "name": "ResponseFailExample", "type": "string", "required": false, "description": "自定义响应配置失败响应示例。", "example": "xxx" }, { "name": "ServiceConfig", "type": "object", "required": false, "description": "API 的后端服务配置。", "example": "无", "children": [ { "name": "Product", "type": "string", "required": false, "description": "后端类型。启用vpc时生效，目前支持的类型为clb, cvm和upstream", "example": "clb" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "vpc 的唯一ID。", "example": "vpc-ssaasd" }, { "name": "Url", "type": "string", "required": false, "description": "API 的后端服务url。如果ServiceType是HTTP，则此参数必传。", "example": "172.17.0.16" }, { "name": "Path", "type": "string", "required": false, "description": "API 的后端服务路径，如 /path。如果 ServiceType 是 HTTP，则此参数必传。前后端路径可不同。", "example": "/" }, { "name": "Method", "type": "string", "required": false, "description": "API的后端服务请求方法，如 GET。如果 ServiceType 是 HTTP，则此参数必传。前后端方法可不同。", "example": "GET" }, { "name": "UpstreamId", "type": "string", "required": false, "description": "当绑定vpc通道才需要 注意：此字段可能返回 null，表示取不到有效值。", "example": "upstream-sadad" }, { "name": "CosConfig", "type": "object", "required": false, "description": "API后端COS配置。如果 ServiceType 是 COS，则此参数必传。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"Key\":\"/cos.txt\",\"Action\":\"GetObject\",\"BucketName\":\"test\",\"Auth", "children": [ { "name": "Action", "type": "string", "required": true, "description": "API调用后端COS的方式，前端请求方法与Action的可选值为： GET：GetObject PUT：PutObject POST：PostObject、AppendObject HEAD： HeadObject DELETE： DeleteObject。 注意：此字段可能返回 null，表示取不到有效值。", "example": "GetObject" }, { "name": "BucketName", "type": "string", "required": true, "description": "API后端COS的存储桶名。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test" }, { "name": "Authorization", "type": "boolean", "required": false, "description": "API调用后端COS的签名开关，默认为false。 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "PathMatchMode", "type": "string", "required": false, "description": "API后端COS的路径匹配模式，可选值： BackEndPath ： 后端路径匹配 FullPath ： 全路径匹配 默认值为：BackEndPath 注意：此字段可能返回 null，表示取不到有效值。", "example": "FullPath" } ] } ] }, { "name": "AuthRelationApiId", "type": "string", "required": false, "description": "关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。", "example": "api-xxx" }, { "name": "ServiceParameters", "type": "array", "required": false, "description": "API的后端服务参数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "Position", "type": "string", "required": false, "description": "API 的后端服务参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterPosition", "type": "string", "required": false, "description": "API 的后端服务参数对应的前端参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterName", "type": "string", "required": false, "description": "API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterDesc", "type": "string", "required": false, "description": "API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterType", "type": "string", "required": false, "description": "API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" } ] }, { "name": "OauthConfig", "type": "object", "required": false, "description": "oauth配置。当AuthType是OAUTH时生效。", "example": "无", "children": [ { "name": "PublicKey", "type": "string", "required": true, "description": "公钥，用于验证用户token。" }, { "name": "TokenLocation", "type": "string", "required": true, "description": "token传递位置。" }, { "name": "LoginRedirectUrl", "type": "string", "required": false, "description": "重定向地址，用于引导用户登录操作。" } ] }, { "name": "ResponseErrorCodes", "type": "array", "required": false, "description": "用户自定义错误码配置。", "example": "无", "item_type": "object", "children": [ { "name": "Code", "type": "integer", "required": false, "description": "自定义响应配置错误码。", "example": "400" }, { "name": "Msg", "type": "string", "required": false, "description": "自定义响应配置错误信息。", "example": "Invalid Format" }, { "name": "Desc", "type": "string", "required": false, "description": "自定义响应配置错误码备注。", "example": "参数错误" }, { "name": "ConvertedCode", "type": "integer", "required": false, "description": "自定义错误码转换。", "example": "401" }, { "name": "NeedConvert", "type": "boolean", "required": false, "description": "是否需要开启错误码转换。", "example": "false" } ] }, { "name": "TargetNamespaceId", "type": "string", "required": false, "description": "tsf serverless 命名空间ID。（内测中）", "example": "xxx" }, { "name": "UserType", "type": "string", "required": false, "description": "用户类型。", "example": "xxx" }, { "name": "IsBase64Encoded", "type": "boolean", "required": false, "description": "是否打开Base64编码，只有后端是scf时才会生效。", "example": "false" }, { "name": "EventBusId", "type": "string", "required": false, "description": "事件总线ID。", "example": "eb-xsae3sdf" }, { "name": "ServiceScfFunctionType", "type": "string", "required": false, "description": "scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。", "example": "EVENT" }, { "name": "ServiceScfEventIsAsyncCall", "type": "boolean", "required": false, "description": "是否开启SCF Event异步调用。", "example": "true" }, { "name": "EIAMAppType", "type": "string", "required": false, "description": "EIAM应用类型。", "example": "Client" }, { "name": "EIAMAuthType", "type": "string", "required": false, "description": "EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。", "example": "Authorization" }, { "name": "TokenTimeout", "type": "integer", "required": false, "description": "EIAM应用Token 有效时间，单位为秒，默认为7200秒。", "example": "7200" }, { "name": "EIAMAppId", "type": "string", "required": false, "description": "EIAM应用ID。", "example": "无" }, { "name": "Owner", "type": "string", "required": false, "description": "资源的Owner", "example": "无" } ], "required": [ "ServiceId", "ServiceType", "ServiceTimeout", "Protocol", "RequestConfig" ] }, { "name": "CreateApiApp", "description": "本接口（CreateApiApp）用于创建应用。", "status": "online", "parameters": [ { "name": "ApiAppName", "type": "string", "required": true, "description": "用户自定义应用名称。", "example": "my-custom-app" }, { "name": "ApiAppDesc", "type": "string", "required": false, "description": "应用描述", "example": "应用描述" } ], "required": [ "ApiAppName" ] }, { "name": "CreateApiKey", "description": "本接口（CreateApiKey）用于创建一对新的 API 密钥。", "status": "online", "parameters": [ { "name": "SecretName", "type": "string", "required": true, "description": "用户自定义密钥名称。", "example": "test" }, { "name": "AccessKeyType", "type": "string", "required": false, "description": "密钥类型，支持 auto 和 manual（自定义密钥），默认为 auto。", "example": "xx" }, { "name": "AccessKeyId", "type": "string", "required": false, "description": "用户自定义密钥 ID，AccessKeyType 为 manual 时必传。长度为5 - 50字符，由字母、数字、英文下划线组成。", "example": "xx" }, { "name": "AccessKeySecret", "type": "string", "required": false, "description": "用户自定义密钥 Key，AccessKeyType 为 manual 时必传。长度为10 - 50字符，由字母、数字、英文下划线。", "example": "xx" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] } ], "required": [ "SecretName" ] }, { "name": "CreateExclusiveInstances", "description": "创建专享实例", "status": "online", "parameters": [ { "name": "Zones", "type": "array", "required": true, "description": "可用区", "example": "ap-chongqing-1,ap-chongqing-2", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型： basic： 基础版 professional： 专业版 enterprise： 企业版 platium： 铂金版 diamond： 钻石版", "example": "basic" }, { "name": "NetworkConfig", "type": "object", "required": true, "description": "网络配置", "example": "无", "children": [ { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "公网带宽", "example": "5000" } ] }, { "name": "VpcConfig", "type": "object", "required": true, "description": "VPC配置", "example": "无", "children": [ { "name": "UniqVpcId", "type": "string", "required": true, "description": "vpcid", "example": "vpc-12345" }, { "name": "UniqSubnetId", "type": "string", "required": true, "description": "subnetid", "example": "subnet-12345" } ] }, { "name": "PayMode", "type": "string", "required": true, "description": "付费类型： POSTPAID：后付费 PREPAID： 预付费", "example": "POSTPAID" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名", "example": "test" }, { "name": "InstanceDescription", "type": "string", "required": false, "description": "实例描述", "example": "实例描述" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] }, { "name": "Period", "type": "integer", "required": false, "description": "预付费付费时长：单位是月", "example": "1" }, { "name": "AutoRenewFlag", "type": "string", "required": false, "description": "预付费续费标志： NOTIFY_AND_MANUAL_RENEW 手动续费 NOTIFY_AND_AUTO_RENEW 自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW 不续费", "example": "NOTIFY_AND_MANUAL_RENEW" } ], "required": [ "Zones", "InstanceType", "NetworkConfig", "VpcConfig", "PayMode" ] }, { "name": "CreateIPStrategy", "description": "本接口（CreateIPStrategy）用于创建服务IP策略。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务的唯一ID。", "example": "service-ody35h5e" }, { "name": "StrategyName", "type": "string", "required": true, "description": "用户自定义的策略名称。", "example": "xx" }, { "name": "StrategyType", "type": "string", "required": true, "description": "策略类型。支持WHITE（白名单）和BLACK（黑名单）。", "example": "WHITE" }, { "name": "StrategyData", "type": "string", "required": true, "description": "策略详情，多个ip 使用\\n 分隔符分开。", "example": "1.1.1.1" } ], "required": [ "ServiceId", "StrategyName", "StrategyType", "StrategyData" ] }, { "name": "CreatePlugin", "description": "创建API网关插件。", "status": "online", "parameters": [ { "name": "PluginName", "type": "string", "required": true, "description": "用户自定义的插件名称。最长50个字符，最短2个字符，支持 a-z,A-Z,0-9,_, 必须字母开头，字母或者数字结尾。", "example": "myplugin" }, { "name": "PluginType", "type": "string", "required": true, "description": "插件类型。目前支持IPControl, TrafficControl, Cors, CustomReq, CustomAuth，Routing，TrafficControlByParameter, CircuitBreaker, ProxyCache。", "example": "IPControl" }, { "name": "PluginData", "type": "string", "required": true, "description": "插件定义语句，支持json。", "example": "无" }, { "name": "Description", "type": "string", "required": false, "description": "插件描述，限定200字以内。", "example": "myPlugin" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] } ], "required": [ "PluginName", "PluginType", "PluginData" ] }, { "name": "CreateService", "description": "本接口（CreateService）用于创建服务。 API 网关使用的最大单元为服务，每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用，用户也可绑定自定义域名到此服务中。", "status": "online", "parameters": [ { "name": "ServiceName", "type": "string", "required": true, "description": "用户自定义的服务名称。", "example": "test_https" }, { "name": "Protocol", "type": "string", "required": true, "description": "服务的前端请求类型。如 http、https、http\u0026https。", "example": "https" }, { "name": "ServiceDesc", "type": "string", "required": false, "description": "用户自定义的服务描述。", "example": "https" }, { "name": "NetTypes", "type": "array", "required": false, "description": "网络类型列表，用于指定支持的访问类型，INNER为内网访问，OUTER为外网访问。默认为OUTER。", "example": "xxx", "item_type": "string" }, { "name": "IpVersion", "type": "string", "required": false, "description": "IP版本号，仅支持IPv4。", "example": "xxxx" }, { "name": "SetServerName", "type": "string", "required": false, "description": "集群名称。保留字段，tsf serverless类型使用。", "example": "xxxx" }, { "name": "AppIdType", "type": "string", "required": false, "description": "用户类型。保留类型，serverless用户使用。", "example": "xxxx" }, { "name": "Tags", "type": "array", "required": false, "description": "标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] }, { "name": "InstanceId", "type": "string", "required": false, "description": "独享实例id", "example": "instance-12345" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "vpc属性，选择VPC后不可修改，为服务选择VPC后，可对接该VPC下的后端资源", "example": "vpc-quyenan" } ], "required": [ "ServiceName", "Protocol" ] }, { "name": "CreateUpstream", "description": "用于创建后端通道", "status": "online", "parameters": [ { "name": "Scheme", "type": "string", "required": true, "description": "后端协议，取值范围：HTTP, HTTPS,gRPC，gRPCs", "example": "HTTP" }, { "name": "Algorithm", "type": "string", "required": true, "description": "负载均衡算法，取值范围：ROUND-ROBIN", "example": "ROUND-ROBIN" }, { "name": "UniqVpcId", "type": "string", "required": true, "description": "VPC唯一ID", "example": "vpc-123456" }, { "name": "UpstreamName", "type": "string", "required": false, "description": "后端通道名字", "example": "test_upstream" }, { "name": "UpstreamDescription", "type": "string", "required": false, "description": "后端通道描述", "example": "description" }, { "name": "UpstreamType", "type": "string", "required": false, "description": "后端访问类型，取值范围：IP_PORT, K8S", "example": "IP_PORT" }, { "name": "Retries", "type": "integer", "required": false, "description": "请求重试次数，默认3次", "example": "3" }, { "name": "UpstreamHost", "type": "string", "required": false, "description": "网关转发到后端的Host请求头", "example": "example.com" }, { "name": "Nodes", "type": "array", "required": false, "description": "后端节点", "example": "无", "item_type": "object", "children": [ { "name": "Host", "type": "string", "required": true, "description": "IP或域名", "example": "1.1.1.1" }, { "name": "Port", "type": "integer", "required": true, "description": "端口[0, 65535]", "example": "22" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重[0, 100], 0为禁用", "example": "10" }, { "name": "VmInstanceId", "type": "string", "required": false, "description": "CVM实例ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ins-123456" }, { "name": "Tags", "type": "array", "required": false, "description": "染色标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"release\",\"test\"]", "item_type": "string" }, { "name": "Healthy", "type": "string", "required": false, "description": "节点健康状态，创建、编辑时不需要传该参数。OFF：关闭，HEALTHY：健康，UNHEALTHY：异常，NO_DATA：数据未上报。目前只支持VPC通道。 注意：此字段可能返回 null，表示取不到有效值。", "example": "OFF" }, { "name": "ServiceName", "type": "string", "required": false, "description": "K8S容器服务名字 注意：此字段可能返回 null，表示取不到有效值。", "example": "web" }, { "name": "NameSpace", "type": "string", "required": false, "description": "K8S命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "Default" }, { "name": "ClusterId", "type": "string", "required": false, "description": "TKE集群的ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "cls-xxxx" }, { "name": "Source", "type": "string", "required": false, "description": "Node的来源，取值范围：K8S 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S" }, { "name": "UniqueServiceName", "type": "string", "required": false, "description": "API网关内部记录唯一的服务名字 注意：此字段可能返回 null，表示取不到有效值。", "example": "/upstream-xxxx/cls-xxx/default/web" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] }, { "name": "HealthChecker", "type": "object", "required": false, "description": "健康检查配置，目前只支持VPC通道", "example": "无", "children": [ { "name": "EnableActiveCheck", "type": "boolean", "required": true, "description": "标识是否开启主动健康检查。", "example": "false" }, { "name": "EnablePassiveCheck", "type": "boolean", "required": true, "description": "标识是否开启被动健康检查。", "example": "false" }, { "name": "HealthyHttpStatus", "type": "string", "required": true, "description": "健康检查时，判断为成功请求的 HTTP 状态码。", "example": "200,201,202" }, { "name": "UnhealthyHttpStatus", "type": "string", "required": true, "description": "健康检查时，判断为失败请求的 HTTP 状态码。", "example": "500,502,503,504" }, { "name": "TcpFailureThreshold", "type": "integer", "required": true, "description": "TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。", "example": "5" }, { "name": "TimeoutThreshold", "type": "integer", "required": true, "description": "连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。", "example": "5" }, { "name": "HttpFailureThreshold", "type": "integer", "required": true, "description": "HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。", "example": "3" }, { "name": "ActiveCheckHttpPath", "type": "string", "required": false, "description": "主动健康检查时探测请求的路径。默认为\"/\"。", "example": "/" }, { "name": "ActiveCheckTimeout", "type": "integer", "required": false, "description": "主动健康检查的探测请求超时，单位秒。默认为5秒。", "example": "5" }, { "name": "ActiveCheckInterval", "type": "integer", "required": false, "description": "主动健康检查的时间间隔，默认5秒。", "example": "5" }, { "name": "ActiveRequestHeader", "type": "array", "required": false, "description": "主动健康检查时探测请求的的请求头。", "example": "None", "item_type": "string" }, { "name": "UnhealthyTimeout", "type": "integer", "required": false, "description": "异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 \u003e 0 的值，否则被动异常节点将无法恢复。默认30秒。", "example": "30" } ] }, { "name": "K8sService", "type": "array", "required": false, "description": "K8S容器服务的配置", "example": "无", "item_type": "object", "children": [ { "name": "Weight", "type": "integer", "required": true, "description": "权重", "example": "10" }, { "name": "ClusterId", "type": "string", "required": true, "description": "k8s集群ID", "example": "cls-ehovttb4" }, { "name": "Namespace", "type": "string", "required": true, "description": "容器命名空间", "example": "Default" }, { "name": "ServiceName", "type": "string", "required": true, "description": "容器服务的名字", "example": "web" }, { "name": "Port", "type": "integer", "required": true, "description": "服务的端口", "example": "8088" }, { "name": "ExtraLabels", "type": "array", "required": true, "description": "额外选择的Pod的Label", "example": "[{\"Key\": \"app\", \"Value\": \"web\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Label的Key", "example": "app" }, { "name": "Value", "type": "string", "required": true, "description": "Label的Value", "example": "web" } ] }, { "name": "Name", "type": "string", "required": false, "description": "自定义的服务名字，可选", "example": "TestServiceName" } ] } ], "required": [ "Scheme", "Algorithm", "UniqVpcId" ] }, { "name": "CreateUsagePlan", "description": "本接口（CreateUsagePlan）用于创建使用计划。 用户在使用 API 网关时，需要创建使用计划并将其绑定到服务的环境中使用。", "status": "online", "parameters": [ { "name": "UsagePlanName", "type": "string", "required": true, "description": "用户自定义的使用计划名称。", "example": "xx" }, { "name": "UsagePlanDesc", "type": "string", "required": false, "description": "用户自定义的使用计划描述。", "example": "xx" }, { "name": "MaxRequestNum", "type": "integer", "required": false, "description": "请求配额总数，取值范围为-1或者[1, 99999999]，默认为-1，表示不开启。", "example": "xx" }, { "name": "MaxRequestNumPreSec", "type": "integer", "required": false, "description": "每秒请求限制数，取值范围为-1或者[1, 2000]，默认-1，表示不开启。", "example": "xx" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] } ], "required": [ "UsagePlanName" ] }, { "name": "DeleteAPIDoc", "description": "删除 API 文档", "status": "online", "parameters": [ { "name": "ApiDocId", "type": "string", "required": true, "description": "API文档ID", "example": "doc-v8tsladd" } ], "required": [ "ApiDocId" ] }, { "name": "DeleteApi", "description": "本接口（DeleteApi）用于删除已经创建的API。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API 所在的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ApiId", "type": "string", "required": true, "description": "API 接口唯一 ID。", "example": "api-e92i2jds" } ], "required": [ "ServiceId", "ApiId" ] }, { "name": "DeleteApiApp", "description": "本接口（DeleteApiApp）用于删除已经创建的应用。", "status": "online", "parameters": [ { "name": "ApiAppId", "type": "string", "required": true, "description": "应用唯一 ID。", "example": "app-e92i2jds" } ], "required": [ "ApiAppId" ] }, { "name": "DeleteApiKey", "description": "本接口（DeleteApiKey）用于删除一对 API 密钥。", "status": "online", "parameters": [ { "name": "AccessKeyId", "type": "string", "required": true, "description": "待删除的密钥 ID。", "example": "AKID***********************************************" } ], "required": [ "AccessKeyId" ] }, { "name": "DeleteIPStrategy", "description": "本接口（DeleteIPStrategy）用于删除服务IP策略。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待删除的IP策略所属的服务唯一ID。", "example": "service-ody35h5e" }, { "name": "StrategyId", "type": "string", "required": true, "description": "待删除的IP策略唯一ID。", "example": "IPStrategy-4xj4r1ou" } ], "required": [ "ServiceId", "StrategyId" ] }, { "name": "DeletePlugin", "description": "删除API网关插件", "status": "online", "parameters": [ { "name": "PluginId", "type": "string", "required": true, "description": "要删除的API网关插件的ID。", "example": "plugin-2nuhovb7" } ], "required": [ "PluginId" ] }, { "name": "DeleteService", "description": "本接口（DeleteService）用于删除 API 网关中某个服务。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待删除服务的唯一 ID。", "example": "service-kaghtzi4" }, { "name": "SkipVerification", "type": "integer", "required": false, "description": "跳过删除前置条件校验（仅支持独享实例上的服务）", "example": "0" } ], "required": [ "ServiceId" ] }, { "name": "DeleteServiceSubDomainMapping", "description": "本接口（DeleteServiceSubDomainMapping）用于删除服务中某个环境的自定义域名映射。 当用户使用自定义域名，并使用了自定义映射时，可使用此接口。但需注意，若删除了所有环境的映射时，调用此 API 均会返回失败。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一 ID。", "example": "service-19c5fnhy" }, { "name": "SubDomain", "type": "string", "required": true, "description": "服务绑定的自定义域名。", "example": "xxxxxxx" }, { "name": "Environment", "type": "string", "required": true, "description": "待删除映射的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。", "example": "test" } ], "required": [ "ServiceId", "SubDomain", "Environment" ] }, { "name": "DeleteUpstream", "description": "删除后端通道，需要注意有API绑定时，不允许删除", "status": "online", "parameters": [ { "name": "UpstreamId", "type": "string", "required": true, "description": "待删除的后端通道ID", "example": "upstream-xxxx" } ], "required": [ "UpstreamId" ] }, { "name": "DeleteUsagePlan", "description": "本接口（DeleteUsagePlan）用于删除使用计划。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "待删除的使用计划唯一 ID。", "example": "usagePlan-bxtnltfd" } ], "required": [ "UsagePlanId" ] }, { "name": "DemoteServiceUsagePlan", "description": "本接口（DemoteServiceUsagePlan）用于将某个服务在某个环境的使用计划，降级到API上。 如果服务内没有API不允许进行此操作。 如果当前环境没有发布，不允许进行此操作。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "使用计划ID。", "example": "usagePlan-bxtnltfd" }, { "name": "ServiceId", "type": "string", "required": true, "description": "待降级的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "Environment", "type": "string", "required": true, "description": "环境名称。", "example": "test" } ], "required": [ "UsagePlanId", "ServiceId", "Environment" ] }, { "name": "DescribeAPIDocDetail", "description": "查询 API 文档详情", "status": "online", "parameters": [ { "name": "ApiDocId", "type": "string", "required": true, "description": "API文档ID", "example": "doc-2dfa4v" } ], "required": [ "ApiDocId" ] }, { "name": "DescribeAPIDocs", "description": "查询 API 文档列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" } ], "required": [] }, { "name": "DescribeAllPluginApis", "description": "展示插件相关的API列表，包括已绑定的和未绑定的API信息。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "要查询的服务ID。", "example": "service-o5as3moe" }, { "name": "PluginId", "type": "string", "required": true, "description": "要查询的插件ID。", "example": "plugin-ca5k53id" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "环境信息。", "example": "release" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" } ], "required": [ "ServiceId", "PluginId", "EnvironmentName" ] }, { "name": "DescribeApi", "description": "本接口（DescribeApi）用于查询用户 API 网关的 API 接口的详细信息。​", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API 所在的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ApiId", "type": "string", "required": true, "description": "API 接口唯一 ID。", "example": "api-3v4tzy3u" } ], "required": [ "ServiceId", "ApiId" ] }, { "name": "DescribeApiApp", "description": "本接口（DescribeApiApp）用于根据应用ID搜索应用。此接口已下线，如需使用功能请使用DescribeApiAppsStatus接口。", "status": "online", "parameters": [ { "name": "ApiAppId", "type": "string", "required": true, "description": "应用ID。", "example": "app-kzofrjbl" } ], "required": [ "ApiAppId" ] }, { "name": "DescribeApiAppBindApisStatus", "description": "本接口（DescribeApiAppBindApisStatus）查询应用绑定的Api列表。", "status": "online", "parameters": [ { "name": "ApiAppId", "type": "string", "required": true, "description": "应用ID", "example": "app-kzofrjbl" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。支持ApiId、ApiName、ServiceId、Environment 、KeyWord（ 可以匹配name或者ID）。", "example": "[{\"Name\":\"ServiceId\",\"Values\":\"service-l29qasn8\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "ApiAppId" ] }, { "name": "DescribeApiAppsStatus", "description": "本接口（DescribeApiAppsStatus）查询应用列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。支持ApiAppId、ApiAppName、KeyWord（ 可以匹配name或者ID）。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeApiBindApiAppsStatus", "description": "本接口（DescribeApiBindApiAppsStatus）查询Api绑定的应用列表。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务ID", "example": "service-l29qasn8" }, { "name": "ApiIds", "type": "array", "required": true, "description": "Api的ID的数组", "example": "[\"api-l29qasn8\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。支持ApiAppId、Environment、KeyWord（ 可以匹配name或者ID）。", "example": "[{\"Name\":\"ApiAppId\",\"Value\":\"app-l29qasn8\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "ServiceId", "ApiIds" ] }, { "name": "DescribeApiEnvironmentStrategy", "description": "本接口（DescribeApiEnvironmentStrategy）用于展示API绑定的限流策略。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API所属服务唯一ID。", "example": "service-ody35h5e" }, { "name": "EnvironmentNames", "type": "array", "required": false, "description": "环境列表。", "example": "[\"test\\r\\n\"]", "item_type": "string" }, { "name": "ApiId", "type": "string", "required": false, "description": "API唯一ID。", "example": "XX" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "XX" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "XX" } ], "required": [ "ServiceId" ] }, { "name": "DescribeApiForApiApp", "description": "本接口（DescribeApiForApiApp）用于应用使用者查询部署于 API 网关的 API 接口的详细信息。​", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API 所在的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ApiId", "type": "string", "required": true, "description": "API 接口唯一 ID。", "example": "api-3v4tzy3u" }, { "name": "ApiRegion", "type": "string", "required": true, "description": "Api所属地域", "example": "ap-guangzhou" } ], "required": [ "ServiceId", "ApiId", "ApiRegion" ] }, { "name": "DescribeApiKey", "description": "本接口（DescribeApiKey）用于查询密钥详情。 用户在创建密钥后，可用此接口查询一个 API 密钥的详情，该接口会显示密钥 Key。", "status": "online", "parameters": [ { "name": "AccessKeyId", "type": "string", "required": true, "description": "API 密钥 ID。", "example": "AKID***********************************************" } ], "required": [ "AccessKeyId" ] }, { "name": "DescribeApiKeysStatus", "description": "本接口（DescribeApiKeysStatus）用于查询密钥列表。 当用户创建了多个密钥对时，可使用本接口查询一个或多个 API 密钥信息。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。支持AccessKeyId、AccessKeySecret、SecretName、NotUsagePlanId、Status、KeyWord（ 可以匹配name或者path）。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeApiUsagePlan", "description": "本接口（DescribeApiUsagePlan）用于查询服务中 API 使用计划详情。 服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务及其中 API 的所有使用计划。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待查询的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" } ], "required": [ "ServiceId" ] }, { "name": "DescribeApisStatus", "description": "本接口（DescribeApisStatus）用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API 所在的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100", "example": "xx" }, { "name": "Filters", "type": "array", "required": false, "description": "API过滤条件。支持ApiId、ApiName、ApiPath、ApiType、AuthRelationApiId、AuthType、ApiBuniessType、NotUsagePlanId、 Environment、Tags (values为 $tag_key:tag_value的列表)、TagKeys （values 为 tag key的列表），其中NotUsagePlanId和Environment必须同时使用，不能单独使用一个。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "ServiceId" ] }, { "name": "DescribeExclusiveInstanceDetail", "description": "本接口（DescribeExclusiveInstanceDetail）用于查询独享实例详情信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "独享实例唯一id", "example": "instance-0c96l2bo" } ], "required": [ "InstanceId" ] }, { "name": "DescribeExclusiveInstanceRegions", "description": "Get the list of supported regions for dedicated instances", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeExclusiveInstances", "description": "本接口（DescribeExclusiveInstances）用于查询独享实例列表信息。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页查询，limit", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页查询，offset", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeExclusiveInstancesStatus", "description": "查询专享实例列表（新）", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页查询，limit", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页查询，offset", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeIPStrategy", "description": "本接口（DescribeIPStrategy）用于查询IP策略详情。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一ID。", "example": "service-ody35h5e" }, { "name": "StrategyId", "type": "string", "required": true, "description": "IP 策略唯一ID。", "example": "IPStrategy-0ez0c8to" }, { "name": "EnvironmentName", "type": "string", "required": false, "description": "策略关联的环境。", "example": "test" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。预留字段，目前不支持过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "ServiceId", "StrategyId" ] }, { "name": "DescribeIPStrategyApisStatus", "description": "本接口（DescribeIPStrategyApisStatus）用于查询IP策略可以绑定的API列表。即服务下所有API和该策略已绑定API的差集。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一ID。", "example": "service-ody35h5e" }, { "name": "StrategyId", "type": "string", "required": true, "description": "策略唯一ID。", "example": "IPStrategy-0ez0c8to" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "策略所在环境。", "example": "test" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。支持 ApiPath、ApiName、KeyWord（模糊查询Path 和Name）。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "ServiceId", "StrategyId", "EnvironmentName" ] }, { "name": "DescribeIPStrategysStatus", "description": "本接口（DescribeIPStrategysStatus）用于查询服务IP策略列表，因为接口名拼写错误，已不推荐使用，请优先使用DescribeIPStrategiesStatus接口。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一ID。", "example": "service-ody35h5e" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。支持StrategyName。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "ServiceId" ] }, { "name": "DescribeInstancesNetworkConfig", "description": "获取专享实例网络配置列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" } ], "required": [] }, { "name": "DescribeLogSearch", "description": "本接口DescribeLogSearch用于搜索日志", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "日志开始时间", "example": "2020-05-28 22:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "日志结束时间", "example": "2020-05-28 23:00:00" }, { "name": "ServiceId", "type": "string", "required": true, "description": "服务id", "example": "service-8xipv0ua" }, { "name": "Filters", "type": "array", "required": false, "description": "保留字段", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "单次要返回的日志条数，单次返回的最大条数为100", "example": "xx" }, { "name": "ConText", "type": "string", "required": false, "description": "根据上次返回的ConText，获取后续的内容，最多可获取10000条", "example": "xx" }, { "name": "Sort", "type": "string", "required": false, "description": "按时间排序 asc（升序）或者 desc（降序），默认为 desc", "example": "xx" }, { "name": "Query", "type": "string", "required": false, "description": "保留字段", "example": "xx" } ], "required": [ "StartTime", "EndTime", "ServiceId" ] }, { "name": "DescribePlugin", "description": "展示插件详情，支持按照插件ID进行。", "status": "online", "parameters": [ { "name": "PluginId", "type": "string", "required": true, "description": "要查询的插件ID。", "example": "plugin-ca5k53id" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" } ], "required": [ "PluginId" ] }, { "name": "DescribePluginApis", "description": "查询指定插件下绑定的API信息", "status": "online", "parameters": [ { "name": "PluginId", "type": "string", "required": true, "description": "查询的插件ID。", "example": "plugin-2nuhovb7" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" } ], "required": [ "PluginId" ] }, { "name": "DescribePlugins", "description": "展示插件列表和详情，支持分页，支持按照插件类型查询，支持按照插件ID批量查询，支持按照插件名称查询。", "status": "online", "parameters": [ { "name": "PluginIds", "type": "array", "required": false, "description": "要查询的插件列表。", "example": "plugin-2nuhovb7", "item_type": "string" }, { "name": "PluginName", "type": "string", "required": false, "description": "要查询的插件名称。", "example": "myplugin" }, { "name": "PluginType", "type": "string", "required": false, "description": "要查询的插件类型。", "example": "IPControl" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。预留字段，目前不支持过滤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribePluginsByApi", "description": "展示API上已绑定的插件列表。", "status": "online", "parameters": [ { "name": "ApiId", "type": "string", "required": true, "description": "要查询的API ID。", "example": "api-fa23vfd" }, { "name": "ServiceId", "type": "string", "required": true, "description": "要查询的服务ID。", "example": "service-o5as3moe" }, { "name": "EnvironmentName", "type": "string", "required": false, "description": "环境信息。", "example": "test" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" } ], "required": [ "ApiId", "ServiceId" ] }, { "name": "DescribeService", "description": "本接口（DescribeService）用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待查询的服务唯一 ID。", "example": "service-rypiqi13" } ], "required": [ "ServiceId" ] }, { "name": "DescribeServiceEnvironmentList", "description": "本接口（DescribeServiceEnvironmentList）用于查询一个服务的环境列表，可查询到此服务下所有环境及其状态。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待查询的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" } ], "required": [ "ServiceId" ] }, { "name": "DescribeServiceEnvironmentReleaseHistory", "description": "本接口（DescribeServiceEnvironmentReleaseHistory）用于查询服务环境的发布历史。 用户在创建好服务后需要发布到某个环境中才能进行使用，本接口用于查询一个服务某个环境的发布记录。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待查询的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "EnvironmentName", "type": "string", "required": false, "description": "环境名称。", "example": "test" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" } ], "required": [ "ServiceId" ] }, { "name": "DescribeServiceEnvironmentStrategy", "description": "本接口（DescribeServiceEnvironmentStrategy）用于展示服务限流策略。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一ID。", "example": "service-ody35h5e" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" } ], "required": [ "ServiceId" ] }, { "name": "DescribeServiceForApiApp", "description": "本接口（DescribeServiceForApiApp）用于应用使用者查询一个服务的详细信息、包括服务的描述、域名、协议等信息。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待查询的服务唯一 ID。", "example": "service-rypiqi13" }, { "name": "ApiRegion", "type": "string", "required": true, "description": "服务所属的地域", "example": "ap-guangzhou" } ], "required": [ "ServiceId", "ApiRegion" ] }, { "name": "DescribeServiceReleaseVersion", "description": "本接口（DescribeServiceReleaseVersion）查询一个服务下面所有已经发布的版本列表。 用户在发布服务时，常有多个版本发布，可使用本接口查询已发布的版本。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待查询的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "xx" } ], "required": [ "ServiceId" ] }, { "name": "DescribeServiceSubDomainMappings", "description": "本接口（DescribeServiceSubDomainMappings）用于查询自定义域名的路径映射。 API 网关可绑定自定义域名到服务，并且可以对自定义域名的路径进行映射，可自定义不同的路径映射到服务中的三个环境，本接口用于查询绑定服务的自定义域名的路径映射列表。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一 ID。", "example": "service-19c5fnhy" }, { "name": "SubDomain", "type": "string", "required": true, "description": "服务绑定的自定义域名。", "example": "xxxxxx" } ], "required": [ "ServiceId", "SubDomain" ] }, { "name": "DescribeServiceSubDomains", "description": "本接口（DescribeServiceSubDomains）用于查询自定义域名列表。 API 网关可绑定自定义域名到服务，用于服务调用。此接口用于查询用户绑定在服务的自定义域名列表。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一 ID。", "example": "service-19c5fnhy" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" } ], "required": [ "ServiceId" ] }, { "name": "DescribeServiceUsagePlan", "description": "本接口（DescribeServiceUsagePlan）用于查询服务使用计划详情。 服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务的所有使用计划。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待查询的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "XX" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "XX" } ], "required": [ "ServiceId" ] }, { "name": "DescribeServicesStatus", "description": "本接口（DescribeServicesStatus）用于搜索查询某一个服务或多个服务的列表，并返回服务相关的域名、时间等信息。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。支持ServiceId、ServiceName、NotUsagePlanId、Environment、IpVersion、InstanceId、NetType、EIAMAppId。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeUpstreamBindApis", "description": "查询后端通道所绑定的API列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页大小", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页起始位置", "example": "0" }, { "name": "UpstreamId", "type": "string", "required": true, "description": "后端通道ID", "example": "xxxxx" }, { "name": "Filters", "type": "array", "required": false, "description": "ServiceId和ApiId过滤查询", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "Limit", "Offset", "UpstreamId" ] }, { "name": "DescribeUpstreams", "description": "查询后端通道列表详情", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页大小", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页起始位置", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，支持后端通道ID（UpstreamId）、后端通道名字（UpstreamName）过滤查询", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeUsagePlan", "description": "本接口（DescribeUsagePlan）用于查询一个使用计划的详细信息，包括名称、QPS、创建时间绑定的环境等。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "待查询的使用计划唯一 ID。", "example": "usagePlan-bxtnltfd" } ], "required": [ "UsagePlanId" ] }, { "name": "DescribeUsagePlanEnvironments", "description": "本接口（DescribeUsagePlanEnvironments）用于查询使用计划绑定的环境列表。 用户在绑定了某个使用计划到环境后，可使用本接口查询这个使用计划绑定的所有服务的环境。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "待查询的使用计划唯一 ID。", "example": "usagePlan-quqxvett" }, { "name": "BindType", "type": "string", "required": true, "description": "定义类型，取值为 API、SERVICE，默认值为 SERVICE。", "example": "API" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" } ], "required": [ "UsagePlanId", "BindType" ] }, { "name": "DescribeUsagePlanSecretIds", "description": "本接口（DescribeUsagePlanSecretIds）用于查询使用计划绑定的密钥列表。 在 API 网关中，一个使用计划可绑定多个密钥对，可使用本接口查询使用计划绑定的密钥列表。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "绑定的使用计划唯一 ID。", "example": "usagePlan-quqxvett" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "xx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "xx" } ], "required": [ "UsagePlanId" ] }, { "name": "DescribeUsagePlansStatus", "description": "本接口（DescribeUsagePlanStatus）用于查询使用计划的列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为 20，最大值为 100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "使用计划过滤条件。支持UsagePlanId、UsagePlanName、NotServiceId、NotApiId、Environment。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "item_type": "string" } ] } ], "required": [] }, { "name": "DetachPlugin", "description": "解除插件与API绑定", "status": "online", "parameters": [ { "name": "PluginId", "type": "string", "required": true, "description": "要解绑的API网关插件ID。", "example": "plugin-2nuhovb7" }, { "name": "ServiceId", "type": "string", "required": true, "description": "要操作的服务ID。", "example": "service-jzo37opy" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "要操作API的环境。", "example": "release" }, { "name": "ApiId", "type": "string", "required": true, "description": "要解绑的API ID。", "example": "['api-1clczx66']" } ], "required": [ "PluginId", "ServiceId", "EnvironmentName", "ApiId" ] }, { "name": "DisableApiKey", "description": "本接口（DisableApiKey）用于禁用一对 API 密钥。", "status": "online", "parameters": [ { "name": "AccessKeyId", "type": "string", "required": true, "description": "待禁用的密钥 ID。", "example": "AKID***********************************************" } ], "required": [ "AccessKeyId" ] }, { "name": "EnableApiKey", "description": "本接口（EnableApiKey）用于启动一对被禁用的 API 密钥。", "status": "online", "parameters": [ { "name": "AccessKeyId", "type": "string", "required": true, "description": "待启用的密钥 ID。", "example": "AKID***********************************************" } ], "required": [ "AccessKeyId" ] }, { "name": "ImportOpenApi", "description": "本接口（ImportOpenApi）用于将OpenAPI规范定义的API导入到API网关。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API所在的服务唯一ID。", "example": "service-xxx" }, { "name": "Content", "type": "string", "required": true, "description": "openAPI正文内容。", "example": "xxx" }, { "name": "EncodeType", "type": "string", "required": false, "description": "Content格式，只能是YAML或者JSON，默认是YAML。", "example": "YAML" }, { "name": "ContentVersion", "type": "string", "required": false, "description": "Content版本，默认是openAPI，目前只支持openAPI。", "example": "openAPI" } ], "required": [ "ServiceId", "Content" ] }, { "name": "ModifyAPIDoc", "description": "修改 API 文档", "status": "online", "parameters": [ { "name": "ApiDocName", "type": "string", "required": true, "description": "API文档名称", "example": "ApiGateWay Doc" }, { "name": "ServiceId", "type": "string", "required": true, "description": "服务名称", "example": "service-2nuhovb7" }, { "name": "Environment", "type": "string", "required": true, "description": "环境名称", "example": "release" }, { "name": "ApiIds", "type": "array", "required": true, "description": "生成文档的API列表", "example": "[api-2dvasde2,api-zewq23]", "item_type": "string" }, { "name": "ApiDocId", "type": "string", "required": true, "description": "API文档ID", "example": "doc-v8tsladd" } ], "required": [ "ApiDocName", "ServiceId", "Environment", "ApiIds", "ApiDocId" ] }, { "name": "ModifyApi", "description": "本接口（ModifyApi）用于修改 API 接口，可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "API 所在的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ServiceType", "type": "string", "required": true, "description": "API 的后端服务类型。支持HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。", "example": "MOCK" }, { "name": "RequestConfig", "type": "object", "required": true, "description": "请求的前端配置。", "example": "无", "children": [ { "name": "Path", "type": "string", "required": true, "description": "API 的路径，如 /path。" }, { "name": "Method", "type": "string", "required": true, "description": "API 的请求方法，如 GET。" } ] }, { "name": "ApiId", "type": "string", "required": true, "description": "API 接口唯一 ID。", "example": "api-lqd35zzq" }, { "name": "ApiName", "type": "string", "required": false, "description": "用户自定义的 API 名称。", "example": "xxx" }, { "name": "ApiDesc", "type": "string", "required": false, "description": "用户自定义的 API 接口描述。", "example": "xxx" }, { "name": "ApiType", "type": "string", "required": false, "description": "API 类型，支持NORMAL和TSF，默认为NORMAL。", "example": "NORMAL" }, { "name": "AuthType", "type": "string", "required": false, "description": "API 鉴权类型。支持SECRET、NONE、OAUTH、APP。默认为NONE。", "example": "NONE" }, { "name": "AuthRequired", "type": "boolean", "required": false, "description": "是否需要签名认证，True 表示需要，False 表示不需要。待废弃。", "example": "False" }, { "name": "ServiceTimeout", "type": "integer", "required": false, "description": "API 的后端服务超时时间，单位是秒。", "example": "15" }, { "name": "Protocol", "type": "string", "required": false, "description": "API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。修改api时推荐必填", "example": "HTTP" }, { "name": "EnableCORS", "type": "boolean", "required": false, "description": "是否需要开启跨域，Ture 表示需要，False 表示不需要。", "example": "False" }, { "name": "ConstantParameters", "type": "array", "required": false, "description": "常量参数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Desc", "type": "string", "required": false, "description": "常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Position", "type": "string", "required": false, "description": "常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "RequestParameters", "type": "array", "required": false, "description": "前端请求参数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "API 的前端参数名称。" }, { "name": "Position", "type": "string", "required": true, "description": "API 的前端参数位置，如 header。目前支持 header、query、path。" }, { "name": "Type", "type": "string", "required": true, "description": "API 的前端参数类型，如 String、int。" }, { "name": "DefaultValue", "type": "string", "required": true, "description": "API 的前端参数默认值。" }, { "name": "Required", "type": "boolean", "required": true, "description": "API 的前端参数是否必填，True：表示必填，False：表示可选。" }, { "name": "Desc", "type": "string", "required": true, "description": "API 的前端参数备注。" } ] }, { "name": "ApiBusinessType", "type": "string", "required": false, "description": "当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。", "example": "NORMAL" }, { "name": "ServiceMockReturnMessage", "type": "string", "required": false, "description": "API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。", "example": "test" }, { "name": "MicroServices", "type": "array", "required": false, "description": "API绑定微服务列表。", "example": "无", "item_type": "object", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "微服务集群。" }, { "name": "NamespaceId", "type": "string", "required": true, "description": "微服务命名空间。" }, { "name": "MicroServiceName", "type": "string", "required": true, "description": "微服务名称。" } ] }, { "name": "ServiceTsfLoadBalanceConf", "type": "object", "required": false, "description": "微服务的负载均衡配置。", "example": "无", "children": [ { "name": "IsLoadBalance", "type": "boolean", "required": false, "description": "是否开启负载均衡。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "Method", "type": "string", "required": false, "description": "负载均衡方式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SessionStickRequired", "type": "boolean", "required": false, "description": "是否开启会话保持。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SessionStickTimeout", "type": "integer", "required": false, "description": "会话保持超时时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ServiceTsfHealthCheckConf", "type": "object", "required": false, "description": "微服务的健康检查配置。", "example": "无", "children": [ { "name": "IsHealthCheck", "type": "boolean", "required": false, "description": "是否开启健康检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RequestVolumeThreshold", "type": "integer", "required": false, "description": "健康检查阈值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SleepWindowInMilliseconds", "type": "integer", "required": false, "description": "窗口大小。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ErrorThresholdPercentage", "type": "integer", "required": false, "description": "阈值百分比。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "TargetServicesLoadBalanceConf", "type": "integer", "required": false, "description": "target类型负载均衡配置。（内测阶段）", "example": "0" }, { "name": "TargetServicesHealthCheckConf", "type": "object", "required": false, "description": "target健康检查配置。（内测阶段）", "example": "无", "children": [ { "name": "IsHealthCheck", "type": "boolean", "required": false, "description": "是否开启健康检查。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "RequestVolumeThreshold", "type": "integer", "required": false, "description": "健康检查阈值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SleepWindowInMilliseconds", "type": "integer", "required": false, "description": "窗口大小。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ErrorThresholdPercentage", "type": "integer", "required": false, "description": "阈值百分比。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ServiceScfFunctionName", "type": "string", "required": false, "description": "scf 函数名称。当后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketRegisterFunctionName", "type": "string", "required": false, "description": "scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketCleanupFunctionName", "type": "string", "required": false, "description": "scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketTransportFunctionName", "type": "string", "required": false, "description": "scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceScfFunctionNamespace", "type": "string", "required": false, "description": "scf 函数命名空间。当后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceScfFunctionQualifier", "type": "string", "required": false, "description": "scf函数版本。当后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketRegisterFunctionNamespace", "type": "string", "required": false, "description": "scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketRegisterFunctionQualifier", "type": "string", "required": false, "description": "scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketTransportFunctionNamespace", "type": "string", "required": false, "description": "scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketTransportFunctionQualifier", "type": "string", "required": false, "description": "scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketCleanupFunctionNamespace", "type": "string", "required": false, "description": "scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceWebsocketCleanupFunctionQualifier", "type": "string", "required": false, "description": "scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。", "example": "xxx" }, { "name": "ServiceScfIsIntegratedResponse", "type": "boolean", "required": false, "description": "是否开启响应集成。当后端类型是SCF时生效。", "example": "False" }, { "name": "IsDebugAfterCharge", "type": "boolean", "required": false, "description": "开始调试后计费。（云市场预留字段）", "example": "False" }, { "name": "TagSpecifications", "type": "object", "required": false, "description": "标签。", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签的 key。", "example": "无" }, { "name": "Value", "type": "string", "required": true, "description": "便签的 value。", "example": "无" } ] }, { "name": "IsDeleteResponseErrorCodes", "type": "boolean", "required": false, "description": "是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。", "example": "False" }, { "name": "ResponseType", "type": "string", "required": false, "description": "返回类型。", "example": "html" }, { "name": "ResponseSuccessExample", "type": "string", "required": false, "description": "自定义响应配置成功响应示例。", "example": "xxx" }, { "name": "ResponseFailExample", "type": "string", "required": false, "description": "自定义响应配置失败响应示例。", "example": "xxx" }, { "name": "ServiceConfig", "type": "object", "required": false, "description": "API 的后端服务配置。", "example": "无", "children": [ { "name": "Product", "type": "string", "required": false, "description": "后端类型。启用vpc时生效，目前支持的类型为clb, cvm和upstream", "example": "clb" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "vpc 的唯一ID。", "example": "vpc-ssaasd" }, { "name": "Url", "type": "string", "required": false, "description": "API 的后端服务url。如果ServiceType是HTTP，则此参数必传。", "example": "172.17.0.16" }, { "name": "Path", "type": "string", "required": false, "description": "API 的后端服务路径，如 /path。如果 ServiceType 是 HTTP，则此参数必传。前后端路径可不同。", "example": "/" }, { "name": "Method", "type": "string", "required": false, "description": "API的后端服务请求方法，如 GET。如果 ServiceType 是 HTTP，则此参数必传。前后端方法可不同。", "example": "GET" }, { "name": "UpstreamId", "type": "string", "required": false, "description": "当绑定vpc通道才需要 注意：此字段可能返回 null，表示取不到有效值。", "example": "upstream-sadad" }, { "name": "CosConfig", "type": "object", "required": false, "description": "API后端COS配置。如果 ServiceType 是 COS，则此参数必传。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"Key\":\"/cos.txt\",\"Action\":\"GetObject\",\"BucketName\":\"test\",\"Auth", "children": [ { "name": "Action", "type": "string", "required": true, "description": "API调用后端COS的方式，前端请求方法与Action的可选值为： GET：GetObject PUT：PutObject POST：PostObject、AppendObject HEAD： HeadObject DELETE： DeleteObject。 注意：此字段可能返回 null，表示取不到有效值。", "example": "GetObject" }, { "name": "BucketName", "type": "string", "required": true, "description": "API后端COS的存储桶名。 注意：此字段可能返回 null，表示取不到有效值。", "example": "test" }, { "name": "Authorization", "type": "boolean", "required": false, "description": "API调用后端COS的签名开关，默认为false。 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "PathMatchMode", "type": "string", "required": false, "description": "API后端COS的路径匹配模式，可选值： BackEndPath ： 后端路径匹配 FullPath ： 全路径匹配 默认值为：BackEndPath 注意：此字段可能返回 null，表示取不到有效值。", "example": "FullPath" } ] } ] }, { "name": "AuthRelationApiId", "type": "string", "required": false, "description": "关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。", "example": "api-xxx" }, { "name": "ServiceParameters", "type": "array", "required": false, "description": "API的后端服务参数。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "Position", "type": "string", "required": false, "description": "API 的后端服务参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterPosition", "type": "string", "required": false, "description": "API 的后端服务参数对应的前端参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterName", "type": "string", "required": false, "description": "API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "DefaultValue", "type": "string", "required": false, "description": "API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterDesc", "type": "string", "required": false, "description": "API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RelevantRequestParameterType", "type": "string", "required": false, "description": "API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。 注意：此字段可能返回 null，表示取不到有效值。" } ] }, { "name": "OauthConfig", "type": "object", "required": false, "description": "oauth配置。当AuthType是OAUTH时生效。", "example": "无", "children": [ { "name": "PublicKey", "type": "string", "required": true, "description": "公钥，用于验证用户token。" }, { "name": "TokenLocation", "type": "string", "required": true, "description": "token传递位置。" }, { "name": "LoginRedirectUrl", "type": "string", "required": false, "description": "重定向地址，用于引导用户登录操作。" } ] }, { "name": "ResponseErrorCodes", "type": "array", "required": false, "description": "用户自定义错误码配置。", "example": "无", "item_type": "object", "children": [ { "name": "Code", "type": "integer", "required": false, "description": "自定义响应配置错误码。", "example": "400" }, { "name": "Msg", "type": "string", "required": false, "description": "自定义响应配置错误信息。", "example": "Invalid Format" }, { "name": "Desc", "type": "string", "required": false, "description": "自定义响应配置错误码备注。", "example": "参数错误" }, { "name": "ConvertedCode", "type": "integer", "required": false, "description": "自定义错误码转换。", "example": "401" }, { "name": "NeedConvert", "type": "boolean", "required": false, "description": "是否需要开启错误码转换。", "example": "false" } ] }, { "name": "IsBase64Encoded", "type": "boolean", "required": false, "description": "是否开启Base64编码，只有后端为scf时才会生效。", "example": "False" }, { "name": "IsBase64Trigger", "type": "boolean", "required": false, "description": "是否开启Base64编码的header触发，只有后端为scf时才会生效。", "example": "False" }, { "name": "Base64EncodedTriggerRules", "type": "array", "required": false, "description": "Header触发规则，总规则数不能超过10。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "进行编码触发的header，可选值 \"Accept\"和\"Content_Type\" 对应实际数据流请求header中的Accept和 Content-Type。" }, { "name": "Value", "type": "array", "required": true, "description": "进行编码触发的header的可选值数组, 数组元素的字符串最大长度为40，元素可以包括数字，英文字母以及特殊字符，特殊字符的可选值为： `.` `+` `*` `-` `/` `_` 例如 [ \"application/x-vpeg005\", \"application/xhtml+xml\", \"application/vnd.ms-project\", \"application/vnd.rn-rn_music_package\" ] 等都是合法的。", "item_type": "string" } ] }, { "name": "EventBusId", "type": "string", "required": false, "description": "事件总线ID。", "example": "eb-3sczdead" }, { "name": "ServiceScfFunctionType", "type": "string", "required": false, "description": "scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。", "example": "EVENT" }, { "name": "ServiceScfEventIsAsyncCall", "type": "boolean", "required": false, "description": "是否开启SCF Event异步调用。", "example": "false" }, { "name": "EIAMAppType", "type": "string", "required": false, "description": "EIAM应用类型。", "example": "Client" }, { "name": "EIAMAuthType", "type": "string", "required": false, "description": "EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。", "example": "Authorization" }, { "name": "EIAMAppId", "type": "string", "required": false, "description": "EIAM应用Token 有效时间，单位为秒，默认为7200秒。", "example": "无" }, { "name": "TokenTimeout", "type": "integer", "required": false, "description": "EIAM应用ID。", "example": "7200" } ], "required": [ "ServiceId", "ServiceType", "RequestConfig", "ApiId" ] }, { "name": "ModifyApiApp", "description": "本接口（ModifyApiApp）用于修改已经创建的应用。", "status": "online", "parameters": [ { "name": "ApiAppId", "type": "string", "required": true, "description": "应用唯一 ID。", "example": "app-e92i2jds" }, { "name": "ApiAppName", "type": "string", "required": false, "description": "修改的应用名称", "example": "test" }, { "name": "ApiAppDesc", "type": "string", "required": false, "description": "修改的应用描述", "example": "test" } ], "required": [ "ApiAppId" ] }, { "name": "ModifyApiEnvironmentStrategy", "description": "本接口（ModifyApiEnvironmentStrategy）用于修改API限流策略", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一ID。", "example": "service-ody35h5e" }, { "name": "Strategy", "type": "integer", "required": true, "description": "限流值。", "example": "3" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "环境名。", "example": "test" }, { "name": "ApiIds", "type": "array", "required": true, "description": "API列表。", "example": "[\"api-e92i2jds\\n\"]", "item_type": "string" } ], "required": [ "ServiceId", "Strategy", "EnvironmentName", "ApiIds" ] }, { "name": "ModifyApiIncrement", "description": "提供增量更新API能力，主要是给程序调用（区别于ModifyApi，该接口是需要传入API的全量参数，对console使用较友好）", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务ID", "example": "xx" }, { "name": "ApiId", "type": "string", "required": true, "description": "接口ID", "example": "xx" }, { "name": "BusinessType", "type": "string", "required": true, "description": "需要修改的API auth类型(可选择OAUTH-授权API)", "example": "xx" }, { "name": "PublicKey", "type": "string", "required": false, "description": "oauth接口需要修改的公钥值", "example": "xx" }, { "name": "LoginRedirectUrl", "type": "string", "required": false, "description": "oauth接口重定向地址", "example": "xx" } ], "required": [ "ServiceId", "ApiId", "BusinessType" ] }, { "name": "ModifyExclusiveInstance", "description": "本接口（ModifyExclusiveInstance）用于修改独享实例信息。​", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "独享实例唯一id", "example": "instance-0c96l2bo" }, { "name": "InstanceName", "type": "string", "required": false, "description": "独享实例name", "example": "test_instance" }, { "name": "InstanceDescription", "type": "string", "required": false, "description": "独享实例描述", "example": "test_instance" }, { "name": "Parameters", "type": "array", "required": false, "description": "独享实例参数配置", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "ServiceRequestNumPreSec，ApiRequestNumPreSec", "example": "ServiceRequestNumPreSec" }, { "name": "Value", "type": "string", "required": true, "description": "参数值", "example": "10" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyIPStrategy", "description": "本接口（ModifyIPStrategy）用于修改服务IP策略。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待修改的策略所属服务的唯一ID。", "example": "service-ody35h5e" }, { "name": "StrategyId", "type": "string", "required": true, "description": "待修改的策略唯一ID。", "example": "IPStrategy-0ez0c8to" }, { "name": "StrategyData", "type": "string", "required": true, "description": "待修改的策略详情。", "example": "3.3.3.3" } ], "required": [ "ServiceId", "StrategyId", "StrategyData" ] }, { "name": "ModifyPlugin", "description": "修改API网关插件。", "status": "online", "parameters": [ { "name": "PluginId", "type": "string", "required": true, "description": "要修改的插件ID。", "example": "plugin-9l0d4sdf" }, { "name": "PluginName", "type": "string", "required": false, "description": "要修改的API网关插件名称。最长50个字符，支持 a-z,A-Z,0-9,_, 必须字母开头，字母或者数字结尾。", "example": "myplugin" }, { "name": "Description", "type": "string", "required": false, "description": "要修改的插件描述，限定200字以内。", "example": "newmodify" }, { "name": "PluginData", "type": "string", "required": false, "description": "要修改的插件定义语句，支持json。", "example": "{\"blocks\":\"1.1.1.1\",\"type\":\"black_list\"}" } ], "required": [ "PluginId" ] }, { "name": "ModifyService", "description": "本接口（ModifyService）用于修改服务的相关信息。当服务创建后，服务的名称、描述和服务类型均可被修改。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待修改服务的唯一 Id。", "example": "service-0c96l2bo" }, { "name": "ServiceName", "type": "string", "required": false, "description": "修改后的服务名称。", "example": "test_https" }, { "name": "ServiceDesc", "type": "string", "required": false, "description": "修改后的服务描述。", "example": "https" }, { "name": "Protocol", "type": "string", "required": false, "description": "修改后的服务前端请求类型，如 http、https和 http\u0026https。", "example": "https" }, { "name": "NetTypes", "type": "array", "required": false, "description": "网络类型列表，用于指定支持的访问类型，INNER为内网访问，OUTER为外网访问。默认为OUTER。", "example": "无", "item_type": "string" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "vpc属性，选择VPC后不可修改。为服务选择VPC后，可对接该VPC下的后端资源", "example": "vpc-adsada" } ], "required": [ "ServiceId" ] }, { "name": "ModifyServiceEnvironmentStrategy", "description": "本接口（ModifyServiceEnvironmentStrategy）用于修改服务限流策略", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务的唯一ID。", "example": "service-ody35h5e" }, { "name": "Strategy", "type": "integer", "required": true, "description": "限流值。", "example": "3" }, { "name": "EnvironmentNames", "type": "array", "required": true, "description": "环境列表。", "example": "[\"test\\n\"]", "item_type": "string" } ], "required": [ "ServiceId", "Strategy", "EnvironmentNames" ] }, { "name": "ModifySubDomain", "description": "本接口（ModifySubDomain）用于修改服务的自定义域名设置中的路径映射，可以修改绑定自定义域名之前的路径映射规则。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一 ID。", "example": "service-19c5fnhy" }, { "name": "SubDomain", "type": "string", "required": true, "description": "待修改路径映射的自定义的域名。", "example": "xxxxxx" }, { "name": "IsDefaultMapping", "type": "boolean", "required": true, "description": "是否修改为使用默认路径映射。为 true，表示使用默认路径映射，为 false，表示使用自定义路径映射。", "example": "false" }, { "name": "CertificateId", "type": "string", "required": false, "description": "证书 ID，协议包含 HTTPS 的时候要传该字段。", "example": "x x" }, { "name": "Protocol", "type": "string", "required": false, "description": "修改后的自定义域名协议类型。（http，https 或 http\u0026https)", "example": "http" }, { "name": "PathMappingSet", "type": "array", "required": false, "description": "修改后的路径映射列表。", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": true, "description": "路径。" }, { "name": "Environment", "type": "string", "required": true, "description": "发布环境，可选值为“test”、 ”prepub“、”release“。" } ] }, { "name": "NetType", "type": "string", "required": false, "description": "网络类型 （'INNER' 或 'OUTER'）", "example": "OUTER" }, { "name": "IsForcedHttps", "type": "boolean", "required": false, "description": "是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。", "example": "x x" } ], "required": [ "ServiceId", "SubDomain", "IsDefaultMapping" ] }, { "name": "ModifyUpstream", "description": "修改后端通道", "status": "online", "parameters": [ { "name": "UpstreamId", "type": "string", "required": true, "description": "后端通道唯一ID", "example": "upstream-0c96l2bo" }, { "name": "UpstreamName", "type": "string", "required": false, "description": "后端通道名字", "example": "upstream_a" }, { "name": "UpstreamDescription", "type": "string", "required": false, "description": "后端通道描述", "example": "description" }, { "name": "Scheme", "type": "string", "required": false, "description": "后端协议，取值范围：HTTP, HTTPS", "example": "HTTP" }, { "name": "UpstreamType", "type": "string", "required": false, "description": "后端访问类型，取值范围：IP_PORT, K8S", "example": "IP_PORT" }, { "name": "Algorithm", "type": "string", "required": false, "description": "负载均衡算法，取值范围：ROUND_ROBIN", "example": "ROUND_ROBIN" }, { "name": "UniqVpcId", "type": "string", "required": false, "description": "VPC唯一ID", "example": "vpc-123456" }, { "name": "Retries", "type": "integer", "required": false, "description": "请求重试次数，默认3次", "example": "3" }, { "name": "UpstreamHost", "type": "string", "required": false, "description": "网关转发到后端的 Host 请求头", "example": "example.com" }, { "name": "Nodes", "type": "array", "required": false, "description": "后端节点列表", "example": "无", "item_type": "object", "children": [ { "name": "Host", "type": "string", "required": true, "description": "IP或域名", "example": "1.1.1.1" }, { "name": "Port", "type": "integer", "required": true, "description": "端口[0, 65535]", "example": "22" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重[0, 100], 0为禁用", "example": "10" }, { "name": "VmInstanceId", "type": "string", "required": false, "description": "CVM实例ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "ins-123456" }, { "name": "Tags", "type": "array", "required": false, "description": "染色标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"release\",\"test\"]", "item_type": "string" }, { "name": "Healthy", "type": "string", "required": false, "description": "节点健康状态，创建、编辑时不需要传该参数。OFF：关闭，HEALTHY：健康，UNHEALTHY：异常，NO_DATA：数据未上报。目前只支持VPC通道。 注意：此字段可能返回 null，表示取不到有效值。", "example": "OFF" }, { "name": "ServiceName", "type": "string", "required": false, "description": "K8S容器服务名字 注意：此字段可能返回 null，表示取不到有效值。", "example": "web" }, { "name": "NameSpace", "type": "string", "required": false, "description": "K8S命名空间 注意：此字段可能返回 null，表示取不到有效值。", "example": "Default" }, { "name": "ClusterId", "type": "string", "required": false, "description": "TKE集群的ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "cls-xxxx" }, { "name": "Source", "type": "string", "required": false, "description": "Node的来源，取值范围：K8S 注意：此字段可能返回 null，表示取不到有效值。", "example": "K8S" }, { "name": "UniqueServiceName", "type": "string", "required": false, "description": "API网关内部记录唯一的服务名字 注意：此字段可能返回 null，表示取不到有效值。", "example": "/upstream-xxxx/cls-xxx/default/web" } ] }, { "name": "HealthChecker", "type": "object", "required": false, "description": "健康检查配置，目前只支持VPC通道", "example": "无", "children": [ { "name": "EnableActiveCheck", "type": "boolean", "required": true, "description": "标识是否开启主动健康检查。", "example": "false" }, { "name": "EnablePassiveCheck", "type": "boolean", "required": true, "description": "标识是否开启被动健康检查。", "example": "false" }, { "name": "HealthyHttpStatus", "type": "string", "required": true, "description": "健康检查时，判断为成功请求的 HTTP 状态码。", "example": "200,201,202" }, { "name": "UnhealthyHttpStatus", "type": "string", "required": true, "description": "健康检查时，判断为失败请求的 HTTP 状态码。", "example": "500,502,503,504" }, { "name": "TcpFailureThreshold", "type": "integer", "required": true, "description": "TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。", "example": "5" }, { "name": "TimeoutThreshold", "type": "integer", "required": true, "description": "连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。", "example": "5" }, { "name": "HttpFailureThreshold", "type": "integer", "required": true, "description": "HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。", "example": "3" }, { "name": "ActiveCheckHttpPath", "type": "string", "required": false, "description": "主动健康检查时探测请求的路径。默认为\"/\"。", "example": "/" }, { "name": "ActiveCheckTimeout", "type": "integer", "required": false, "description": "主动健康检查的探测请求超时，单位秒。默认为5秒。", "example": "5" }, { "name": "ActiveCheckInterval", "type": "integer", "required": false, "description": "主动健康检查的时间间隔，默认5秒。", "example": "5" }, { "name": "ActiveRequestHeader", "type": "array", "required": false, "description": "主动健康检查时探测请求的的请求头。", "example": "None", "item_type": "string" }, { "name": "UnhealthyTimeout", "type": "integer", "required": false, "description": "异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 \u003e 0 的值，否则被动异常节点将无法恢复。默认30秒。", "example": "30" } ] }, { "name": "K8sService", "type": "array", "required": false, "description": "容器服务配置", "example": "无", "item_type": "object", "children": [ { "name": "Weight", "type": "integer", "required": true, "description": "权重", "example": "10" }, { "name": "ClusterId", "type": "string", "required": true, "description": "k8s集群ID", "example": "cls-ehovttb4" }, { "name": "Namespace", "type": "string", "required": true, "description": "容器命名空间", "example": "Default" }, { "name": "ServiceName", "type": "string", "required": true, "description": "容器服务的名字", "example": "web" }, { "name": "Port", "type": "integer", "required": true, "description": "服务的端口", "example": "8088" }, { "name": "ExtraLabels", "type": "array", "required": true, "description": "额外选择的Pod的Label", "example": "[{\"Key\": \"app\", \"Value\": \"web\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Label的Key", "example": "app" }, { "name": "Value", "type": "string", "required": true, "description": "Label的Value", "example": "web" } ] }, { "name": "Name", "type": "string", "required": false, "description": "自定义的服务名字，可选", "example": "TestServiceName" } ] } ], "required": [ "UpstreamId" ] }, { "name": "ModifyUsagePlan", "description": "本接口（ModifyUsagePlan）用于修改使用计划的名称，描述及 QPS。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "使用计划唯一 ID。", "example": "usagePlan-bxtnltfd" }, { "name": "UsagePlanName", "type": "string", "required": false, "description": "修改后的用户自定义的使用计划名称。", "example": "xx" }, { "name": "UsagePlanDesc", "type": "string", "required": false, "description": "修改后的用户自定义的使用计划描述。", "example": "xx" }, { "name": "MaxRequestNum", "type": "integer", "required": false, "description": "请求配额总数，取值范围为-1或者[1, 99999999]，默认为-1，表示不开启。", "example": "xx" }, { "name": "MaxRequestNumPreSec", "type": "integer", "required": false, "description": "每秒请求限制数，取值范围为-1或者[1, 2000]，默认-1，表示不开启。", "example": "xx" } ], "required": [ "UsagePlanId" ] }, { "name": "ReleaseService", "description": "本接口（ReleaseService）用于发布服务。 API 网关的服务创建后，需要发布到某个环境方生效后，使用者才能进行调用，此接口用于发布服务到环境，如 release 环境。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待发布服务的唯一 ID。", "example": "service-ody35h5e" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "待发布的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。", "example": "prepub" }, { "name": "ReleaseDesc", "type": "string", "required": true, "description": "本次的发布描述。", "example": "xx" }, { "name": "ApiIds", "type": "array", "required": false, "description": "apiId列表，预留字段，默认全量api发布。", "example": "无", "item_type": "string" } ], "required": [ "ServiceId", "EnvironmentName", "ReleaseDesc" ] }, { "name": "ResetAPIDocPassword", "description": "重置API文档密码", "status": "online", "parameters": [ { "name": "ApiDocId", "type": "string", "required": true, "description": "API文档ID", "example": "apidoc-d2sdvx3s" } ], "required": [ "ApiDocId" ] }, { "name": "UnBindEnvironment", "description": "本接口（UnBindEnvironment）用于将使用计划从特定环境解绑。", "status": "online", "parameters": [ { "name": "BindType", "type": "string", "required": true, "description": "绑定类型，取值为 API、SERVICE，默认值为 SERVICE。", "example": "SERVICE" }, { "name": "UsagePlanIds", "type": "array", "required": true, "description": "待绑定的使用计划唯一 ID 列表。", "example": "[\"usagePlan-quqxvett\\r\\n\"]", "item_type": "string" }, { "name": "Environment", "type": "string", "required": true, "description": "待解绑的服务环境。", "example": "test" }, { "name": "ServiceId", "type": "string", "required": true, "description": "待解绑的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ApiIds", "type": "array", "required": false, "description": "API 唯一 ID 数组，当 BindType=API 时，需要传入此参数。", "example": "xx", "item_type": "string" } ], "required": [ "BindType", "UsagePlanIds", "Environment", "ServiceId" ] }, { "name": "UnBindIPStrategy", "description": "本接口（UnBindIPStrategy）用于服务解绑IP策略。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待解绑的服务唯一ID。", "example": "service-ody35h5e" }, { "name": "StrategyId", "type": "string", "required": true, "description": "待解绑的IP策略唯一ID。", "example": "IPStrategy-0ez0c8to" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "待解绑的环境。", "example": "test" }, { "name": "UnBindApiIds", "type": "array", "required": true, "description": "待解绑的 API 列表。", "example": "[\"api-e92i2jds\\r\\n\"]", "item_type": "string" } ], "required": [ "ServiceId", "StrategyId", "EnvironmentName", "UnBindApiIds" ] }, { "name": "UnBindSecretIds", "description": "本接口（UnBindSecretIds）用于为使用计划解绑密钥。", "status": "online", "parameters": [ { "name": "UsagePlanId", "type": "string", "required": true, "description": "待解绑的使用计划唯一 ID。", "example": "usagePlan-quqxvett" }, { "name": "AccessKeyIds", "type": "array", "required": true, "description": "待解绑的密钥 ID 数组。", "example": "[\"AKID***********************************************\\n\"]", "item_type": "string" } ], "required": [ "UsagePlanId", "AccessKeyIds" ] }, { "name": "UnBindSubDomain", "description": "本接口（UnBindSubDomain）用于解绑自定义域名。 用户使用 API 网关绑定了自定义域名到服务中后，若想要解绑此自定义域名，可使用此接口。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务唯一 ID。", "example": "service-19c5fnhy" }, { "name": "SubDomain", "type": "string", "required": true, "description": "待解绑的自定义的域名。", "example": "xxxxxxxx" } ], "required": [ "ServiceId", "SubDomain" ] }, { "name": "UnReleaseService", "description": "本接口（UnReleaseService）用于下线服务。 用户发布服务到某个环境后，此服务中的 API 方可被调用者进行调用，当用户需要将此服务从发布环境中下线时，可调用此 API。下线后的服务不可被调用。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待下线服务的唯一 ID。", "example": "service-ody35h5e" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "待下线的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。", "example": "prepub" }, { "name": "ApiIds", "type": "array", "required": false, "description": "保留字段，待下线的API列表。", "example": "api-hnetytr6", "item_type": "string" } ], "required": [ "ServiceId", "EnvironmentName" ] }, { "name": "UnbindApiApp", "description": "本接口（UnbindApiApp）用于解除应用和API绑定。", "status": "online", "parameters": [ { "name": "ApiAppId", "type": "string", "required": true, "description": "待绑定的应用唯一 ID 。", "example": "app-kzofrjbl" }, { "name": "Environment", "type": "string", "required": true, "description": "待绑定的环境。", "example": "test" }, { "name": "ServiceId", "type": "string", "required": true, "description": "待绑定的服务唯一 ID。", "example": "service-ody35h5e" }, { "name": "ApiId", "type": "string", "required": true, "description": "待绑定的API唯一ID。", "example": "api-c6piso8y" } ], "required": [ "ApiAppId", "Environment", "ServiceId", "ApiId" ] }, { "name": "UpdateApiAppKey", "description": "本接口（UpdateApiAppKey）用于更新应用密钥。", "status": "online", "parameters": [ { "name": "ApiAppId", "type": "string", "required": true, "description": "应用唯一 ID。", "example": "app-e92i2jds" }, { "name": "ApiAppKey", "type": "string", "required": true, "description": "应用的Key。", "example": "xxx" }, { "name": "ApiAppSecret", "type": "string", "required": false, "description": "应用的Secret。", "example": "xxx" } ], "required": [ "ApiAppId", "ApiAppKey" ] }, { "name": "UpdateApiKey", "description": "本接口（UpdateApiKey）用于更换用户已创建的一对 API 密钥。", "status": "online", "parameters": [ { "name": "AccessKeyId", "type": "string", "required": true, "description": "待更换的密钥 ID。", "example": "AKID***********************************************" }, { "name": "AccessKeySecret", "type": "string", "required": false, "description": "待更换的密钥 Key，更新自定义密钥时，该字段为必传。长度10 - 50字符，包括字母、数字、英文下划线。", "example": "xx" } ], "required": [ "AccessKeyId" ] }, { "name": "UpdateService", "description": "本接口（UpdateService）用于从服务已发布的环境中将运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后，如在开发过程产生多个版本需要切换，此时可调用本接口。", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "待切换服务的唯一 Id。", "example": "service-ody35h5e" }, { "name": "EnvironmentName", "type": "string", "required": true, "description": "待切换的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。", "example": "test" }, { "name": "VersionName", "type": "string", "required": true, "description": "切换的版本号。", "example": "202002161926124aa59df4-7198-4f7a-acc7-887ab7ee0215" }, { "name": "UpdateDesc", "type": "string", "required": false, "description": "本次的切换描述。", "example": "test" } ], "required": [ "ServiceId", "EnvironmentName", "VersionName" ] } ] }