数据结构

最近更新时间:2024-01-31 01:06:31

我的收藏

APIDoc

API文档基本信息

被如下接口引用:CreateAPIDoc, DescribeAPIDocs, ModifyAPIDoc, ResetAPIDocPassword。

名称 类型 描述
ApiDocId String API文档ID
示例值:doc-1fa3rs3s
ApiDocName String API文档名称
示例值:test
ApiDocStatus String API文档构建状态
示例值:PROCESSING
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。

APIDocInfo

API文档详细信息

被如下接口引用:DescribeAPIDocDetail。

名称 类型 描述
ApiDocId String API文档ID
示例值:apidoc-a7ragqam
ApiDocName String API文档名称
示例值:test
ApiDocStatus String API文档构建状态
示例值:COMPLETED
ApiCount Integer API文档API数量
示例值:1
ViewCount Integer API文档查看次数
示例值:2
ReleaseCount Integer API文档发布次数
示例值:3
ApiDocUri String API文档访问URI
示例值:https://apidoc-a7ragqam-apigw.doc.coding.io
SharePassword String API文档分享密码
示例值:000000
UpdatedTime Timestamp API文档更新时间
示例值:2021-01-25T05:46:25Z
ServiceId String 服务ID
示例值:service-2nuhovb7
Environment String 环境信息
示例值:release
ApiIds Array of String 生成API文档的API ID
示例值:[api-d2sdvxd]
ServiceName String 服务名称
示例值:service
ApiNames Array of String 生成API文档的API名称
示例值:[api]
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。

APIDocs

API文档列表

被如下接口引用:DescribeAPIDocs。

名称 类型 描述
TotalCount Integer API文档数量
示例值:7
APIDocSet Array of APIDoc API文档基本信息

ApiAppApiInfo

应用绑定的Api信息

被如下接口引用:DescribeApiAppBindApisStatus, DescribeApiBindApiAppsStatus。

名称 类型 描述
ApiAppName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
ApiAppId String 应用ID
ApiId String Api的ID
注意:此字段可能返回 null,表示取不到有效值。
ApiName String Api名称
注意:此字段可能返回 null,表示取不到有效值。
ServiceId String 服务ID
注意:此字段可能返回 null,表示取不到有效值。
AuthorizedTime Timestamp ISO8601 授权绑定时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ApiRegion String Api所属地域
注意:此字段可能返回 null,表示取不到有效值。
EnvironmentName String 授权绑定的环境
注意:此字段可能返回 null,表示取不到有效值。

ApiAppApiInfos

应用信息集

被如下接口引用:DescribeApiAppBindApisStatus, DescribeApiBindApiAppsStatus。

名称 类型 描述
TotalCount Integer 数量
ApiAppApiSet Array of ApiAppApiInfo 应用绑定的Api信息数组
注意:此字段可能返回 null,表示取不到有效值。

ApiAppInfo

应用信息

被如下接口引用:CreateApiApp, DescribeApiApp, DescribeApiAppsStatus。

名称 类型 描述
ApiAppName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:x x
ApiAppId String 应用ID
示例值:x x
ApiAppSecret String 应用SECRET
注意:此字段可能返回null,表示取不到有效值
注意:此字段可能返回 null,表示取不到有效值。
示例值:sajsnda
ApiAppDesc String 应用描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:x x
CreatedTime Timestamp ISO8601 创建时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-09-01
ModifiedTime Timestamp ISO8601 修改时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-09-01
ApiAppKey String 应用KEY
注意:此字段可能返回null,表示取不到有效值
注意:此字段可能返回 null,表示取不到有效值。
示例值:sajsnda

ApiAppInfos

应用信息集

被如下接口引用:DescribeApiApp, DescribeApiAppsStatus。

名称 类型 描述
TotalCount Integer 应用数量
ApiAppSet Array of ApiAppInfo 应用信息数组
注意:此字段可能返回 null,表示取不到有效值。

ApiEnvironmentStrategy

api环境绑定策略

被如下接口引用:DescribeApiEnvironmentStrategy。

名称 类型 描述
ApiId String API唯一ID。
ApiName String 用户自定义API名称。
Path String API的路径。如/path。
Method String API的方法。如GET。
EnvironmentStrategySet Array of EnvironmentStrategy 环境的限流信息。

ApiEnvironmentStrategyStatus

API绑定策略列表

被如下接口引用:DescribeApiEnvironmentStrategy。

名称 类型 描述
TotalCount Integer API绑定的限流策略数量。
注意:此字段可能返回 null,表示取不到有效值。
ApiEnvironmentStrategySet Array of ApiEnvironmentStrategy API绑定的限流策略列表。
注意:此字段可能返回 null,表示取不到有效值。

ApiIdStatus

API状态

被如下接口引用:DescribeService, DescribeServiceForApiApp。

名称 类型 描述
ServiceId String 服务唯一ID。
ApiId String API唯一ID。
ApiDesc String API描述
注意:此字段可能返回 null,表示取不到有效值。
Path String API PATH。
Method String API METHOD。
CreatedTime Timestamp ISO8601 服务创建时间。
ModifiedTime Timestamp ISO8601 服务修改时间。
ApiName String API名称。
注意:此字段可能返回 null,表示取不到有效值。
UniqVpcId String VPC唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiType String API类型。
注意:此字段可能返回 null,表示取不到有效值。
Protocol String API协议。
注意:此字段可能返回 null,表示取不到有效值。
IsDebugAfterCharge Boolean 是否买后调试。
注意:此字段可能返回 null,表示取不到有效值。
AuthType String 授权类型。
注意:此字段可能返回 null,表示取不到有效值。
ApiBusinessType String API业务类型。
注意:此字段可能返回 null,表示取不到有效值。
AuthRelationApiId String 关联授权API唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
OauthConfig OauthConfig oauth配置信息。
注意:此字段可能返回 null,表示取不到有效值。
TokenLocation String oauth2.0API请求,token存放位置。
注意:此字段可能返回 null,表示取不到有效值。

ApiInfo

展示api信息

被如下接口引用:DescribeApi, DescribeApiForApiApp。

名称 类型 描述
ServiceId String API 所在的服务唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
ServiceName String API 所在的服务的名称。
注意:此字段可能返回 null,表示取不到有效值。
ServiceDesc String API 所在的服务的描述。
注意:此字段可能返回 null,表示取不到有效值。
ApiId String API 接口唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiDesc String API 接口的描述。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime Timestamp ISO8601 创建时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 最后修改时间,按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ApiName String API 接口的名称。
注意:此字段可能返回 null,表示取不到有效值。
ApiType String API 类型。可取值为NORMAL(普通API)、TSF(微服务API)。
注意:此字段可能返回 null,表示取不到有效值。
Protocol String API 的前端请求类型,如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。
注意:此字段可能返回 null,表示取不到有效值。
AuthType String API 鉴权类型。可取值为 SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH。
注意:此字段可能返回 null,表示取不到有效值。
ApiBusinessType String OAUTH API的类型。可取值为NORMAL(业务API)、OAUTH(授权API)。
注意:此字段可能返回 null,表示取不到有效值。
AuthRelationApiId String OAUTH 业务API 关联的授权API 唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
OauthConfig OauthConfig OAUTH配置。
注意:此字段可能返回 null,表示取不到有效值。
IsDebugAfterCharge Boolean 是否购买后调试(云市场预留参数)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
RequestConfig RequestConfig 请求的前端配置。
注意:此字段可能返回 null,表示取不到有效值。
ResponseType String 返回类型。
注意:此字段可能返回 null,表示取不到有效值。
ResponseSuccessExample String 自定义响应配置成功响应示例。
注意:此字段可能返回 null,表示取不到有效值。
ResponseFailExample String 自定义响应配置失败响应示例。
注意:此字段可能返回 null,表示取不到有效值。
ResponseErrorCodes Array of ErrorCodes 用户自定义错误码配置。
注意:此字段可能返回 null,表示取不到有效值。
RequestParameters Array of ReqParameter 前端请求参数。
注意:此字段可能返回 null,表示取不到有效值。
ServiceTimeout Integer API 的后端服务超时时间,单位是秒。
注意:此字段可能返回 null,表示取不到有效值。
ServiceType String API 的后端服务类型。可取值为 HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET(内测)。
注意:此字段可能返回 null,表示取不到有效值。
ServiceConfig ServiceConfig API 的后端服务配置。
注意:此字段可能返回 null,表示取不到有效值。
ServiceParameters Array of DescribeApiResultServiceParametersInfo API的后端服务参数。
注意:此字段可能返回 null,表示取不到有效值。
ConstantParameters Array of ConstantParameter 常量参数。
注意:此字段可能返回 null,表示取不到有效值。
ServiceMockReturnMessage String API 的后端 Mock 返回信息。如果 ServiceType 是 Mock,则此参数必传。
注意:此字段可能返回 null,表示取不到有效值。
ServiceScfFunctionName String scf 函数名称。当后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceScfFunctionNamespace String scf 函数命名空间。当后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceScfFunctionQualifier String scf函数版本。当后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceScfIsIntegratedResponse Boolean 是否开启集成响应。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ServiceWebsocketRegisterFunctionName String scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketRegisterFunctionNamespace String scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketRegisterFunctionQualifier String scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketCleanupFunctionName String scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketCleanupFunctionNamespace String scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketCleanupFunctionQualifier String scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
InternalDomain String WEBSOCKET 回推地址。
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketTransportFunctionName String scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketTransportFunctionNamespace String scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
ServiceWebsocketTransportFunctionQualifier String scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。
注意:此字段可能返回 null,表示取不到有效值。
MicroServices Array of MicroService API绑定微服务列表。
注意:此字段可能返回 null,表示取不到有效值。
MicroServicesInfo Array of Integer 微服务信息详情。
注意:此字段可能返回 null,表示取不到有效值。
ServiceTsfLoadBalanceConf TsfLoadBalanceConfResp 微服务的负载均衡配置。
注意:此字段可能返回 null,表示取不到有效值。
ServiceTsfHealthCheckConf HealthCheckConf 微服务的健康检查配置。
注意:此字段可能返回 null,表示取不到有效值。
EnableCORS Boolean 是否开启跨域。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Tags Array of Tag API绑定的tag信息。
注意:此字段可能返回 null,表示取不到有效值。
Environments Array of String API已发布的环境信息。
注意:此字段可能返回 null,表示取不到有效值。
IsBase64Encoded Boolean 是否开启Base64编码,只有后端为scf时才会生效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsBase64Trigger Boolean 是否开启Base64编码的header触发,只有后端为scf时才会生效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Base64EncodedTriggerRules Array of Base64EncodedTriggerRule Header触发规则,总规则数量不超过10。
注意:此字段可能返回 null,表示取不到有效值。
ServiceScfEventIsAsyncCall Boolean 是否开启SCF Event异步调用。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false

ApiInfoSummary

插件相关的API列表信息。

被如下接口引用:DescribeAllPluginApis。

名称 类型 描述
TotalCount Integer 插件相关的API总数。
示例值:1
ApiSet Array of AvailableApiInfo 插件相关的API信息。

ApiKey

密钥详情

被如下接口引用:CreateApiKey, DescribeApiKey, DescribeApiKeysStatus, UpdateApiKey。

名称 类型 描述
AccessKeyId String 创建的 API 密钥 ID 。
AccessKeySecret String 创建的 API 密钥 Key。
AccessKeyType String 密钥类型,auto 或者 manual。
SecretName String 用户自定义密钥名称。
ModifiedTime Timestamp ISO8601 最后一次修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
Status Integer 密钥状态。0表示禁用,1表示启用。
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。

ApiKeysStatus

密钥列表

被如下接口引用:DescribeApiKeysStatus。

名称 类型 描述
TotalCount Integer 符合条件的 API 密钥数量。
注意:此字段可能返回 null,表示取不到有效值。
ApiKeySet Array of ApiKey API 密钥列表。
注意:此字段可能返回 null,表示取不到有效值。

ApiRequestConfig

api请求配置

被如下接口引用:CreateApi。

名称 类型 必选 描述
Path String path
Method String 方法

ApiUsagePlan

api或service绑定使用计划详情

被如下接口引用:DescribeApiUsagePlan, DescribeServiceUsagePlan。

名称 类型 描述
ServiceId String 服务唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiId String API 唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiName String API 名称。
注意:此字段可能返回 null,表示取不到有效值。
Path String API 路径。
注意:此字段可能返回 null,表示取不到有效值。
Method String API 方法。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanId String 使用计划的唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanName String 使用计划的名称。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanDesc String 使用计划的描述。
注意:此字段可能返回 null,表示取不到有效值。
Environment String 使用计划绑定的服务环境。
注意:此字段可能返回 null,表示取不到有效值。
InUseRequestNum Integer 已经使用的配额。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum Integer 请求配额总量,-1表示没有限制。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec Integer 请求 QPS 上限,-1 表示没有限制。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime Timestamp ISO8601 使用计划创建时间。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 使用计划最后修改时间。
注意:此字段可能返回 null,表示取不到有效值。
ServiceName String 服务名称。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。

ApiUsagePlanSet

api绑定使用计划列表

被如下接口引用:DescribeApiUsagePlan。

名称 类型 描述
TotalCount Integer API 绑定的使用计划总数。
注意:此字段可能返回 null,表示取不到有效值。
ApiUsagePlanList Array of ApiUsagePlan API 绑定使用计划列表。
注意:此字段可能返回 null,表示取不到有效值。

ApigatewayTags

key-value

被如下接口引用:DescribeApisStatus。

名称 类型 描述

AttachedApiInfo

插件绑定的API信息

被如下接口引用:CreatePlugin, DescribePlugin, DescribePluginApis。

名称 类型 描述
ServiceId String API所在服务ID。
ServiceName String API所在服务名称。
ServiceDesc String API所在服务描述信息。
注意:此字段可能返回 null,表示取不到有效值。
ApiId String API ID。
ApiName String API名称。
ApiDesc String API描述。
注意:此字段可能返回 null,表示取不到有效值。
Environment String 插件绑定API的环境。
AttachedTime Timestamp ISO8601 插件和API绑定时间。

AttachedApiSummary

插件绑定的API列表

被如下接口引用:DescribePluginApis。

名称 类型 描述
TotalCount Integer 插件绑定的API数量。
AttachedApis Array of AttachedApiInfo 插件绑定的API信息。

AttachedPluginInfo

已绑定的插件信息。

被如下接口引用:DescribePluginsByApi。

名称 类型 描述
PluginId String 插件ID。
示例值:plugin-9l0d4sdf
Environment String 环境信息。
示例值:release
AttachedTime String 绑定时间。
示例值:2021-01-25T06:56:58Z
PluginName String 插件名称。
示例值:myplugin
PluginType String 插件类型。
示例值:IPControl
Description String 插件描述。
示例值:IPControl
PluginData String 插件定义语句。
示例值:{"blocks":"1.1.1.1","type":"black_list"}

AttachedPluginSummary

已绑定的插件信息。

被如下接口引用:DescribePluginsByApi。

名称 类型 描述
TotalCount Integer 已绑定的插件总数。
示例值:1
PluginSummary Array of AttachedPluginInfo 已绑定的插件信息。

AvailableApiInfo

插件相关的API信息。

被如下接口引用:DescribeAllPluginApis。

名称 类型 描述
ApiId String API ID。
示例值:api-d2sdvx
ApiName String API名称。
示例值:helloapi
ApiType String API类型。
示例值:Normal
Path String API路径。
示例值:/happy
Method String API方法。
示例值:GET
AttachedOtherPlugin Boolean API是否绑定其他插件。
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
IsAttached Boolean API是否绑定当前插件。
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

Base64EncodedTriggerRule

Base64编码的header触发规则

被如下接口引用:DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
Name String 进行编码触发的header,可选值 "Accept"和"Content_Type" 对应实际数据流请求header中的Accept和 Content-Type。
Value Array of String 进行编码触发的header的可选值数组, 数组元素的字符串最大长度为40,元素可以包括数字,英文字母以及特殊字符,特殊字符的可选值为: . + * - / _

例如 [
"application/x-vpeg005",
"application/xhtml+xml",
"application/vnd.ms-project",
"application/vnd.rn-rn_music_package"
] 等都是合法的。

BindApiInfo

vpc通道绑定的api信息

被如下接口引用:DescribeUpstreamBindApis。

名称 类型 描述
ApiId String api唯一id
示例值:api-sadasd
ServiceId String Service唯一id
示例值:service-asdaada
ApiName String api名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:sajsnda
ServiceName String 服务名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
BindTime Timestamp ISO8601 绑定时间
示例值:2018-10-30T04:24:19Z

ConstantParameter

常量参数

被如下接口引用:CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
Name String 常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
Desc String 常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
Position String 常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
DefaultValue String 常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。

CosConfig

cos类型的api配置

被如下接口引用:CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
Action String API调用后端COS的方式,前端请求方法与Action的可选值为:
GET:GetObject
PUT:PutObject
POST:PostObject、AppendObject
HEAD: HeadObject
DELETE: DeleteObject。
注意:此字段可能返回 null,表示取不到有效值。
示例值:GetObject
BucketName String API后端COS的存储桶名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Authorization Boolean API调用后端COS的签名开关,默认为false。
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
PathMatchMode String API后端COS的路径匹配模式,可选值:
BackEndPath : 后端路径匹配
FullPath : 全路径匹配

默认值为:BackEndPath
注意:此字段可能返回 null,表示取不到有效值。
示例值:FullPath

CreateApiResultInfo

创建api返回

被如下接口引用:CreateApi。

名称 类型 描述
ApiId String api id
注意:此字段可能返回 null,表示取不到有效值。
示例值:api-sdfsdf
Path String 路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/
Method String 请求方法
注意:此字段可能返回 null,表示取不到有效值。
示例值:GET
CreatedTime Timestamp ISO8601 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-03-02T14:27:56Z

CreateApiRsp

创建api返回

被如下接口引用:ImportOpenApi。

名称 类型 描述
ApiId String api id
注意:此字段可能返回 null,表示取不到有效值。
示例值:api-sdfsdf
Path String 路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:/
Method String 请求方法
注意:此字段可能返回 null,表示取不到有效值。
示例值:GET
CreatedTime Timestamp ISO8601 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-03-02T14:27:56Z
Status String 导入状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
ErrMsg String 异常信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:ok
ApiName String api name
注意:此字段可能返回 null,表示取不到有效值。
示例值:api-xxxxx

CreateApiRspSet

CreateApiRsp 返回加TotalCount

被如下接口引用:ImportOpenApi。

名称 类型 描述
TotalCount Integer 个数
示例值:0
ApiSet Array of CreateApiRsp 返回的数组
示例值:[]

DesApisStatus

api状态详情

被如下接口引用:CreateIPStrategy, DescribeIPStrategy。

名称 类型 描述
ServiceId String 服务唯一ID。
示例值:service-2nuhovb7
ApiId String API唯一ID。
示例值:api-d2sdvx
ApiDesc String 用户自定义的 API 接口描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:API
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ApiName String API 接口的名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:apiname
VpcId Integer VPCID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1
UniqVpcId String VPC唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiType String API类型。取值为NORMAL(普通API)和TSF(微服务API)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:NORMAL
Protocol String API协议。
注意:此字段可能返回 null,表示取不到有效值。
示例值:HTTP
IsDebugAfterCharge Boolean 是否买后调试。(云市场预留字段)
注意:此字段可能返回 null,表示取不到有效值。
示例值:False
AuthType String API 鉴权类型。取值为SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、EIAM。
注意:此字段可能返回 null,表示取不到有效值。
示例值:EIAM
ApiBusinessType String OAUTH API的类型。当AuthType 为 OAUTH时该字段有效, 取值为NORMAL(业务API)和 OAUTH(授权API)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:OAUTH
AuthRelationApiId String 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:api-dd3acs
OauthConfig OauthConfig OAUTH 配置信息。当AuthType是OAUTH时生效。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of String API关联的标签信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
Path String API 的路径,如 /path。
注意:此字段可能返回 null,表示取不到有效值。
示例值:/hello
Method String API 的请求方法,如 GET。
注意:此字段可能返回 null,表示取不到有效值。
示例值:GET

DescribeApiResultServiceParametersInfo

ServiceParameter

被如下接口引用:DescribeApi, DescribeApiForApiApp。

名称 类型 必选 描述
Name String API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。
注意:此字段可能返回 null,表示取不到有效值。
Position String API 的后端服务参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。
注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterPosition String API 的后端服务参数对应的前端参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterName String API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
DefaultValue String API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterDesc String API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。

DescribeApisStatusResultApiIdStatusSetInfo

api状态详情

被如下接口引用:DescribeApisStatus。

名称 类型 描述
ServiceId String 服务唯一ID。
示例值:service-2nuhovb7
ApiId String API唯一ID。
示例值:api-d2sdvx
ApiDesc String 用户自定义的 API 接口描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:API
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ApiName String API 接口的名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:apiname
VpcId Integer VPCID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1
UniqVpcId String VPC唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiType String API类型。取值为NORMAL(普通API)和TSF(微服务API)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:NORMAL
Protocol String API协议。
注意:此字段可能返回 null,表示取不到有效值。
示例值:HTTP
IsDebugAfterCharge Boolean 是否买后调试。(云市场预留字段)
注意:此字段可能返回 null,表示取不到有效值。
示例值:False
AuthType String API 鉴权类型。取值为SECRET(密钥对鉴权)、NONE(免鉴权)、OAUTH、EIAM。
注意:此字段可能返回 null,表示取不到有效值。
示例值:EIAM
ApiBusinessType String OAUTH API的类型。当AuthType 为 OAUTH时该字段有效, 取值为NORMAL(业务API)和 OAUTH(授权API)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:OAUTH
AuthRelationApiId String 关联的授权API 唯一 ID,当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:api-dd3acs
OauthConfig OauthConfig OAUTH 配置信息。当AuthType是OAUTH时生效。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of ApigatewayTags API关联的标签信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
Path String API 的路径,如 /path。
注意:此字段可能返回 null,表示取不到有效值。
示例值:/hello
Method String API 的请求方法,如 GET。
注意:此字段可能返回 null,表示取不到有效值。
示例值:GET

DescribeApisStatusResultInfo

描述api列表状态

被如下接口引用:DescribeApisStatus。

名称 类型 描述
TotalCount Integer 符合条件的 API 接口数量。
ApiIdStatusSet Array of DescribeApisStatusResultApiIdStatusSetInfo API 接口列表。

DescribeExclusiveInstancesResult

数据结构

被如下接口引用:DescribeExclusiveInstances。

名称 类型 描述

DescribeServiceReleaseVersionResultVersionListInfo

服务发布列表详情

被如下接口引用:DescribeServiceReleaseVersion。

名称 类型 描述
VersionName String 版本号。
注意:此字段可能返回 null,表示取不到有效值。
VersionDesc String 版本描述。
注意:此字段可能返回 null,表示取不到有效值。

DescribeUpstreamBindApis

查询后端通道绑定API列表

被如下接口引用:DescribeUpstreamBindApis。

名称 类型 描述
TotalCount Integer 总数
示例值:1
BindApiSet Array of BindApiInfo 绑定的API信息

DescribeUpstreamInfo

查询后端通道返回信息

被如下接口引用:DescribeUpstreams。

名称 类型 描述
TotalCount Integer 查询总数
示例值:1
UpstreamSet Array of UpstreamInfo 查询列表

DomainSetList

服务自定义域名列表

被如下接口引用:DescribeServiceSubDomains。

名称 类型 描述
DomainName String 域名名称。
示例值:www.xx.com
Status Integer 域名解析状态。1 表示正常解析,0 表示解析失败。
示例值:1
CertificateId String 证书ID。
IsDefaultMapping Boolean 是否使用默认路径映射。
示例值:true
Protocol String 自定义域名协议类型。
示例值:http
NetType String 网络类型('INNER' 或 'OUTER')。
示例值:OUTER
IsForcedHttps Boolean 是否将HTTP请求强制跳转 HTTPS,默认为false。参数为 true时,API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
示例值:false
RegistrationStatus Boolean 域名备案注册状态
示例值:true

DomainSets

自定义服务域名展示

被如下接口引用:DescribeServiceSubDomains。

名称 类型 描述
TotalCount Integer 服务下的自定义域名数量。
DomainSet Array of DomainSetList 自定义服务域名列表。

Environment

服务发布的环境信息。

被如下接口引用:DescribeServiceEnvironmentList。

名称 类型 描述
EnvironmentName String 环境名称。
Url String 访问路径。
Status Integer 发布状态,1 表示已发布,0 表示未发布。
VersionName String 运行版本。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。

EnvironmentStrategy

环境限流

被如下接口引用:DescribeApiEnvironmentStrategy。

名称 类型 描述
EnvironmentName String 环境名
示例值:x x
Quota Integer 限流值
示例值:1

ErrorCodes

用户自定义错误码

被如下接口引用:DescribeApi, DescribeApiForApiApp。

名称 类型 必选 描述
Code Integer 自定义响应配置错误码。
注意:此字段可能返回 null,表示取不到有效值。
Msg String 自定义响应配置错误信息。
注意:此字段可能返回 null,表示取不到有效值。
Desc String 自定义响应配置错误码备注。
注意:此字段可能返回 null,表示取不到有效值。
ConvertedCode Integer 自定义错误码转换。
注意:此字段可能返回 null,表示取不到有效值。
NeedConvert Boolean 是否需要开启错误码转换。
注意:此字段可能返回 null,表示取不到有效值。

Filter

描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等

  • 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
  • 若同一个Filter存在多个Values,同一FilterValues间的关系为逻辑或(OR)关系。

被如下接口引用:DescribeApiAppBindApisStatus, DescribeApiAppsStatus, DescribeApiBindApiAppsStatus, DescribeApiKeysStatus, DescribeApisStatus, DescribeExclusiveInstances, DescribeExclusiveInstancesStatus, DescribeIPStrategy, DescribeIPStrategyApisStatus, DescribeIPStrategysStatus, DescribeLogSearch, DescribePlugins, DescribeServicesStatus, DescribeUpstreamBindApis, DescribeUpstreams, DescribeUsagePlansStatus。

名称 类型 必选 描述
Name String 需要过滤的字段。
Values Array of String 字段的过滤值。

HealthCheckConf

健康检查配置,包括TsfHealthCheckConf和TargetServicesHealthCheckConf

被如下接口引用:CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
IsHealthCheck Boolean 是否开启健康检查。
注意:此字段可能返回 null,表示取不到有效值。
RequestVolumeThreshold Integer 健康检查阈值。
注意:此字段可能返回 null,表示取不到有效值。
SleepWindowInMilliseconds Integer 窗口大小。
注意:此字段可能返回 null,表示取不到有效值。
ErrorThresholdPercentage Integer 阈值百分比。
注意:此字段可能返回 null,表示取不到有效值。

IPStrategiesStatus

策略列表

被如下接口引用:DescribeIPStrategysStatus。

名称 类型 描述
TotalCount Integer 策略数量。
注意:此字段可能返回 null,表示取不到有效值。
StrategySet Array of IPStrategy 策略列表。
注意:此字段可能返回 null,表示取不到有效值。

IPStrategy

ip策略

被如下接口引用:CreateIPStrategy, DescribeIPStrategy, DescribeIPStrategysStatus。

名称 类型 描述
StrategyId String 策略唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
StrategyName String 用户自定义策略名称。
注意:此字段可能返回 null,表示取不到有效值。
StrategyType String 策略类型。支持WHITE(白名单)和BLACK(黑名单)。
注意:此字段可能返回 null,表示取不到有效值。
StrategyData String IP列表。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 修改时间。
注意:此字段可能返回 null,表示取不到有效值。
ServiceId String 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
BindApiTotalCount Integer 策略绑定的API数量。
注意:此字段可能返回 null,表示取不到有效值。
BindApis Array of DesApisStatus 绑定的API详情。
注意:此字段可能返回 null,表示取不到有效值。

IPStrategyApi

策略绑定api列表

被如下接口引用:DescribeIPStrategyApisStatus。

名称 类型 描述
ApiId String API 唯一 ID。
ApiName String 用户自定义的 API 名称。
ApiType String API 类型。取值为NORMAL(普通API)和TSF (微服务API)。
Path String API 的路径。如 /path。
Method String API 的请求方法。如 GET。
OtherIPStrategyId String API 已经绑定的其他策略唯一ID。
OtherEnvironmentName String API 已经绑定的环境。

IPStrategyApiStatus

ip策略绑定api详情

被如下接口引用:DescribeIPStrategyApisStatus。

名称 类型 描述
TotalCount Integer 环境绑定API数量。
注意:此字段可能返回 null,表示取不到有效值。
ApiIdStatusSet Array of IPStrategyApi 环境绑定API详情。
注意:此字段可能返回 null,表示取不到有效值。

InstanceChargePrepaid

独享实例预付费详情

被如下接口引用:DescribeExclusiveInstanceDetail, DescribeExclusiveInstancesStatus, ModifyExclusiveInstance。

名称 类型 描述
RenewFlag String 自动续费标示
示例值:NOTIFY_AND_MANUAL_RENEW
ExpiredTime Timestamp ISO8601 预付费到期时间
示例值:2018-10-30 04:24:19

InstanceDetail

独享实例详情

被如下接口引用:DescribeExclusiveInstanceDetail, ModifyExclusiveInstance。

名称 类型 描述
InstanceId String 独享实例唯一id
示例值:instance-0c96l2bo
Zone String 可用区
示例值:ap-guangzhou-1
InstanceName String 独享实例名字
示例值:test_instance
InstanceDescription String 独享实例描述
示例值:test_instance
InstanceChargeType String 独享实例计费类型
示例值:PREPAID
InstanceState String 独享实例状态
示例值:RUNNING
InstanceChargePrepaid InstanceChargePrepaid 独享实例预付费类型
注意:此字段可能返回 null,表示取不到有效值。
InstanceType String 独享实例类型
示例值:BASIC
NetworkConfig NetworkConfig 独享实例网络类型
注意:此字段可能返回 null,表示取不到有效值。
VpcConfig VpcConfig 独享实例vpc配置
Parameters Array of ParameterInfo 独享实例参数配置
注意:此字段可能返回 null,表示取不到有效值。
IsolationStartedTime Timestamp ISO8601 独享实例隔离时间
示例值:0000-0000-00 00-00-00
CreatedTime Timestamp ISO8601 创建时间
示例值:2018-10-30 04:24:19Z
Zones Array of String 可用区列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:['ap-guangzhou-1','ap-guangzhou-1']

InstanceInfo

独享实例信息

被如下接口引用:DescribeExclusiveInstancesStatus。

名称 类型 描述
InstanceId String 独享实例唯一id
示例值:instance-0c96l2bo
InstanceName String 独享实例name
示例值:test
InstanceDescription String 独享实例描述
示例值:test
InstanceChargeType String 独享实例计费类型
示例值:PREPAID
InstanceType String 独享实例类型
示例值:BASIC
InstanceState String 独享实例状态
示例值:RUNNING
CreatedTime Timestamp ISO8601 独享实例创建时间
示例值:2021-01-25T10:15:21Z
DealName String 订单号
注意:此字段可能返回 null,表示取不到有效值。
示例值:20210321891210021
ResourceId String 资源ID同唯一id
示例值:instance-9459tdbs
OuterIpList Array of String 公网IP列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["127.0.0.1"]
InnerIpList Array of String 内网IP列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["127.0.0.1"]
InstanceChargePrepaid InstanceChargePrepaid 专享实例计费信息
注意:此字段可能返回 null,表示取不到有效值。
UniqVpcId String 所属vpc
注意:此字段可能返回 null,表示取不到有效值。

InstanceParameterInput

独享实例参数信息

被如下接口引用:ModifyExclusiveInstance。

名称 类型 必选 描述
Name String ServiceRequestNumPreSec,ApiRequestNumPreSec
示例值:ServiceRequestNumPreSec
Value String 参数值
示例值:10

InstanceSummary

专享查询列表

被如下接口引用:DescribeExclusiveInstancesStatus。

名称 类型 描述
TotalCount Integer 专享实例总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InstanceSet Array of InstanceInfo 专享实例列表
注意:此字段可能返回 null,表示取不到有效值。

K8sLabel

k8s Label

被如下接口引用:CreateUpstream, ModifyUpstream。

名称 类型 必选 描述
Key String Label的Key
示例值:app
Value String Label的Value
示例值:web

K8sService

k8s 服务的配置

被如下接口引用:CreateUpstream, DescribeUpstreams, ModifyUpstream。

名称 类型 必选 描述
Weight Integer 权重
示例值:10
ClusterId String k8s集群ID
示例值:cls-ehovttb4
Namespace String 容器命名空间
示例值:Default
ServiceName String 容器服务的名字
示例值:web
Port Integer 服务的端口
示例值:8088
ExtraLabels Array of K8sLabel 额外选择的Pod的Label
示例值:[{"Key": "app", "Value": "web"}]
Name String 自定义的服务名字,可选
示例值:TestServiceName

MicroService

API绑定的微服务信息。

被如下接口引用:DescribeApi, DescribeApiForApiApp。

名称 类型 必选 描述
ClusterId String 微服务集群ID。
NamespaceId String 微服务命名空间ID。
MicroServiceName String 微服务名称。

MicroServiceReq

tsf类型入参

被如下接口引用:CreateApi, ModifyApi。

名称 类型 必选 描述
ClusterId String 微服务集群。
NamespaceId String 微服务命名空间。
MicroServiceName String 微服务名称。

ModifyUpstreamResultInfo

后端通道详细信息

被如下接口引用:ModifyUpstream。

名称 类型 描述
UpstreamId String 后端通道唯一ID
示例值:upstream-xxxx
UpstreamName String 后端通道名字
示例值:test_upstream
UpstreamDescription String 后端通道描述
示例值:description
Scheme String 后端协议,取值范围:HTTP, HTTPS
示例值:HTTP
Algorithm String 负载均衡算法,取值范围:ROUND_ROBIN
示例值:ROUND_ROBIN
UniqVpcId String VPC唯一ID
示例值:vpc-123456
Retries Integer 请求重试次数
示例值:3
Nodes Array of UpstreamNode 后端节点
示例值:x x
CreatedTime Timestamp ISO8601 创建时间
示例值:x x
HealthChecker UpstreamHealthChecker 健康检查配置
注意:此字段可能返回 null,表示取不到有效值。
UpstreamType String 后端的类型,取值范围:IP_PORT, K8S
示例值:K8S
K8sServices Array of K8sService K8S容器服务配置
注意:此字段可能返回 null,表示取不到有效值。
UpstreamHost String 网关转发给后端的Host请求头
注意:此字段可能返回 null,表示取不到有效值。

NetworkConfig

独享实例网络配置

被如下接口引用:DescribeExclusiveInstanceDetail, ModifyExclusiveInstance。

名称 类型 描述
InternetMaxBandwidthOut Integer 最大出带宽
示例值:10
EnableInternetInbound Boolean EnableInternetInbound信息
示例值:true
EnableInternetOutbound Boolean EnableInternetOutbound信息
示例值:true
InboundIpAddresses Array of String InboundIpAddresses信息
示例值:["10.10.10.10"]
OutboundIpAddresses Array of String OutboundIpAddresses信息
示例值:["10.10.10.10"]

OauthConfig

Oauth授权配置信息

被如下接口引用:CreateApi, CreateIPStrategy, DescribeApi, DescribeApiForApiApp, DescribeApisStatus, DescribeIPStrategy, DescribeService, DescribeServiceForApiApp, ModifyApi。

名称 类型 必选 描述
PublicKey String 公钥,用于验证用户token。
TokenLocation String token传递位置。
LoginRedirectUrl String 重定向地址,用于引导用户登录操作。

ParameterInfo

独享实例配置参数

被如下接口引用:DescribeExclusiveInstanceDetail, ModifyExclusiveInstance。

名称 类型 描述
Name String 名字
示例值:服务QPS上限
Value Integer 当前值
示例值:10
Default Integer 默认值
示例值:10
Unit String 单位
示例值:次/秒
Type String 类型, integer|string
示例值:integer
Minimum Integer 最小
示例值:0
Maximum Integer 最大
示例值:10
ValueString String 字符类型的值,当Type为string时才有意义
注意:此字段可能返回 null,表示取不到有效值。
示例值:TLSv1
DefaultValueString String 字符类型的默认值,当Type为string时才有意义
注意:此字段可能返回 null,表示取不到有效值。
示例值:TLSv1
Range String 可调整范围
注意:此字段可能返回 null,表示取不到有效值。
示例值:[TLSv1,TLSv1.1,TLSv1.2]

PathMapping

自定义域名的路径映射。

被如下接口引用:BindSubDomain, DescribeServiceSubDomainMappings, ModifySubDomain。

名称 类型 必选 描述
Path String 路径。
Environment String 发布环境,可选值为“test”、 ”prepub“、”release“。

Plugin

API网关插件详情。

被如下接口引用:CreatePlugin, DescribePlugin, DescribePlugins。

名称 类型 描述
PluginId String 插件ID。
示例值:plugin-2nuhovb7
PluginName String 插件名称。
示例值:myplugin
PluginType String 插件类型。
示例值:IPControl
PluginData String 插件定义语句。
示例值:{\
Description String 插件描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPControl
CreatedTime Timestamp ISO8601 插件创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
示例值:2021-01-25T10:15:21Z
ModifiedTime Timestamp ISO8601 插件修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
示例值:2021-01-25T10:15:21Z
AttachedApiTotalCount Integer 插件绑定的API总数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AttachedApis Array of AttachedApiInfo 插件绑定的API信息。
注意:此字段可能返回 null,表示取不到有效值。

PluginSummary

插件列表详情。

被如下接口引用:DescribePlugins。

名称 类型 描述
TotalCount Integer 插件个数。
PluginSet Array of Plugin 插件详情。

ReleaseService

发布服务返回

被如下接口引用:ReleaseService。

名称 类型 描述
ReleaseDesc String 发布时的备注信息填写。
注意:此字段可能返回 null,表示取不到有效值。
ReleaseVersion String 发布的版本id。
注意:此字段可能返回 null,表示取不到有效值。

ReqParameter

请求参数

被如下接口引用:DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
Name String API 的前端参数名称。
Position String API 的前端参数位置,如 header。目前支持 header、query、path。
Type String API 的前端参数类型,如 String、int。
DefaultValue String API 的前端参数默认值。
Required Boolean API 的前端参数是否必填,True:表示必填,False:表示可选。
Desc String API 的前端参数备注。

RequestConfig

前端路径配置

被如下接口引用:DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
Path String API 的路径,如 /path。
Method String API 的请求方法,如 GET。

RequestParameter

请求参数

被如下接口引用:CreateApi。

名称 类型 必选 描述
Name String 请求参数名称
Desc String 描述
Position String 参数位置
Type String 参数类型
DefaultValue String 默认值
Required Boolean 是否必须

ResponseErrorCodeReq

错误码入参

被如下接口引用:CreateApi, ModifyApi。

名称 类型 必选 描述
Code Integer 自定义响应配置错误码。
示例值:400
Msg String 自定义响应配置错误信息。
示例值:Invalid Format
Desc String 自定义响应配置错误码备注。
示例值:参数错误
ConvertedCode Integer 自定义错误码转换。
示例值:401
NeedConvert Boolean 是否需要开启错误码转换。
示例值:false

Service

展示服务列表用

被如下接口引用:DescribeServicesStatus。

名称 类型 描述
InnerHttpsPort Integer 内网访问https端口。
注意:此字段可能返回 null,表示取不到有效值。
ServiceDesc String 用户自定义的服务描述。
注意:此字段可能返回 null,表示取不到有效值。
Protocol String 服务的前端请求类型。如http、https 或者 http&https。
注意:此字段可能返回 null,表示取不到有效值。
示例值:http
ModifiedTime Timestamp ISO8601 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
NetTypes Array of String 服务支持的网络类型。
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx
ExclusiveSetName String 独占集群名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
ServiceId String 服务唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
IpVersion String IP版本。
注意:此字段可能返回 null,表示取不到有效值。
AvailableEnvironments Array of String 已经发布的环境列表。如test、prepub、release。
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
ServiceName String 用户自定义的服务名称。
注意:此字段可能返回 null,表示取不到有效值。
OuterSubDomain String 系统为该服务分配的外网域名。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
InnerHttpPort Integer 内网访问http端口。
注意:此字段可能返回 null,表示取不到有效值。
InnerSubDomain String 系统为该服务自动分配的内网域名。
注意:此字段可能返回 null,表示取不到有效值。
TradeIsolateStatus Integer 服务的计费状态。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tag 服务绑定的标签
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 独享实例
注意:此字段可能返回 null,表示取不到有效值。
SetType String 集群类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:x x
DeploymentType String 服务部署的集群类型
注意:此字段可能返回 null,表示取不到有效值。

ServiceConfig

ServiceConfig配置

被如下接口引用:CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
Product String 后端类型。启用vpc时生效,目前支持的类型为clb, cvm和upstream
示例值:clb
UniqVpcId String vpc 的唯一ID。
示例值:vpc-ssaasd
Url String API 的后端服务url。如果ServiceType是HTTP,则此参数必传。
示例值:172.17.0.16
Path String API 的后端服务路径,如 /path。如果 ServiceType 是 HTTP,则此参数必传。前后端路径可不同。
示例值:/
Method String API的后端服务请求方法,如 GET。如果 ServiceType 是 HTTP,则此参数必传。前后端方法可不同。
示例值:GET
UpstreamId String 当绑定vpc通道才需要
注意:此字段可能返回 null,表示取不到有效值。
示例值:upstream-sadad
CosConfig CosConfig API后端COS配置。如果 ServiceType 是 COS,则此参数必传。
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Key":"/cos.txt","Action":"GetObject","BucketName":"test","Auth

ServiceEnvironmentSet

服务绑定环境详情

被如下接口引用:DescribeServiceEnvironmentList。

名称 类型 描述
TotalCount Integer 服务绑定环境总数。
注意:此字段可能返回 null,表示取不到有效值。
EnvironmentList Array of Environment 服务绑定环境列表。
注意:此字段可能返回 null,表示取不到有效值。

ServiceEnvironmentStrategy

服务环境策略

被如下接口引用:DescribeServiceEnvironmentStrategy。

名称 类型 描述
EnvironmentName String 环境名。
示例值:x x
Url String 访问服务对应环境的url。
示例值:x x
Status Integer 发布状态。
示例值:x x
VersionName String 发布的版本号。
注意:此字段可能返回 null,表示取不到有效值。
示例值:x x
Strategy Integer 限流值。
示例值:1
MaxStrategy Integer 最大限流值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ServiceEnvironmentStrategyStatus

环境绑定策略列表

被如下接口引用:DescribeServiceEnvironmentStrategy。

名称 类型 描述
TotalCount Integer 限流策略数量。
注意:此字段可能返回 null,表示取不到有效值。
EnvironmentList Array of ServiceEnvironmentStrategy 限流策略列表。
注意:此字段可能返回 null,表示取不到有效值。

ServiceParameter

ServiceParameter

被如下接口引用:CreateApi, ModifyApi。

名称 类型 必选 描述
Name String API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。
注意:此字段可能返回 null,表示取不到有效值。
Position String API 的后端服务参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。
注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterPosition String API 的后端服务参数对应的前端参数位置,如 head。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterName String API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
DefaultValue String API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterDesc String API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。
RelevantRequestParameterType String API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。
注意:此字段可能返回 null,表示取不到有效值。

ServiceReleaseHistory

服务发布历史

被如下接口引用:DescribeServiceEnvironmentReleaseHistory。

名称 类型 描述
TotalCount Integer 发布版本总数。
注意:此字段可能返回 null,表示取不到有效值。
VersionList Array of ServiceReleaseHistoryInfo 历史版本列表。
注意:此字段可能返回 null,表示取不到有效值。

ServiceReleaseHistoryInfo

服务发布列表详情

被如下接口引用:DescribeServiceEnvironmentReleaseHistory。

名称 类型 描述
VersionName String 版本号。
注意:此字段可能返回 null,表示取不到有效值。
VersionDesc String 版本描述。
注意:此字段可能返回 null,表示取不到有效值。
ReleaseTime String 版本发布时间。
注意:此字段可能返回 null,表示取不到有效值。

ServiceReleaseVersion

服务发布版本

被如下接口引用:DescribeServiceReleaseVersion。

名称 类型 描述
TotalCount Integer 发布版本总数量。
注意:此字段可能返回 null,表示取不到有效值。
VersionList Array of DescribeServiceReleaseVersionResultVersionListInfo 发布版本列表。
注意:此字段可能返回 null,表示取不到有效值。

ServiceSubDomainMappings

服务自定义域名路径映射

被如下接口引用:DescribeServiceSubDomainMappings。

名称 类型 描述
IsDefaultMapping Boolean 是否使用默认路径映射,为 True 表示使用默认路径映射;为 False 的话,表示使用自定义路径映射,此时 PathMappingSet 不为空。
PathMappingSet Array of PathMapping 自定义路径映射列表。

ServiceUsagePlanSet

服务绑定使用计划列表

被如下接口引用:DescribeServiceUsagePlan。

名称 类型 描述
TotalCount Integer 服务上绑定的使用计划总数。
注意:此字段可能返回 null,表示取不到有效值。
ServiceUsagePlanList Array of ApiUsagePlan 服务上绑定的使用计划列表。
注意:此字段可能返回 null,表示取不到有效值。

ServicesStatus

服务列表展示

被如下接口引用:DescribeServicesStatus。

名称 类型 描述
TotalCount Integer 服务列表总数。
注意:此字段可能返回 null,表示取不到有效值。
ServiceSet Array of Service 服务列表详情。
注意:此字段可能返回 null,表示取不到有效值。

Tag

API绑定的标签信息。

被如下接口引用:CreateAPIDoc, CreateApiKey, CreatePlugin, CreateService, CreateUpstream, CreateUsagePlan, DescribeAPIDocDetail, DescribeApi, DescribeApiForApiApp, DescribeApiKey, DescribeApiUsagePlan, DescribeService, DescribeServiceForApiApp, DescribeServiceUsagePlan, DescribeServicesStatus, DescribeUpstreams, DescribeUsagePlan, DescribeUsagePlansStatus, ModifyAPIDoc, ModifyApi, ModifyUsagePlan, ResetAPIDocPassword, UpdateApiKey。

名称 类型 必选 描述
Key String 标签的 key。
Value String 便签的 value。

TargetServicesReq

tsf serverless入参

被如下接口引用:CreateApi。

名称 类型 必选 描述
VmIp String vm ip
VpcId String vpc id
VmPort Integer vm port
HostIp String cvm所在宿主机ip
DockerIp String docker ip

TsfLoadBalanceConfResp

TsfLoadBalanceConf 出参使用

被如下接口引用:CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi。

名称 类型 必选 描述
IsLoadBalance Boolean 是否开启负载均衡。
注意:此字段可能返回 null,表示取不到有效值。
Method String 负载均衡方式。
注意:此字段可能返回 null,表示取不到有效值。
SessionStickRequired Boolean 是否开启会话保持。
注意:此字段可能返回 null,表示取不到有效值。
SessionStickTimeout Integer 会话保持超时时间。
注意:此字段可能返回 null,表示取不到有效值。

UpstreamHealthChecker

后端通道健康检查参数配置

被如下接口引用:CreateUpstream, DescribeUpstreams, ModifyUpstream。

名称 类型 必选 描述
EnableActiveCheck Boolean 标识是否开启主动健康检查。
示例值:false
EnablePassiveCheck Boolean 标识是否开启被动健康检查。
示例值:false
HealthyHttpStatus String 健康检查时,判断为成功请求的 HTTP 状态码。
示例值:200,201,202
UnhealthyHttpStatus String 健康检查时,判断为失败请求的 HTTP 状态码。
示例值:500,502,503,504
TcpFailureThreshold Integer TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围:[0, 254]。
示例值:5
TimeoutThreshold Integer 连续超时阈值。0 表示禁用超时检查。取值范围:[0, 254]。
示例值:5
HttpFailureThreshold Integer HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围:[0, 254]。
示例值:3
ActiveCheckHttpPath String 主动健康检查时探测请求的路径。默认为"/"。
示例值:/
ActiveCheckTimeout Integer 主动健康检查的探测请求超时,单位秒。默认为5秒。
示例值:5
ActiveCheckInterval Integer 主动健康检查的时间间隔,默认5秒。
示例值:5
ActiveRequestHeader Array of UpstreamHealthCheckerReqHeaders 主动健康检查时探测请求的的请求头。
示例值:None
UnhealthyTimeout Integer 异常节点的状态自动恢复时间,单位秒。当只开启被动检查的话,必须设置为 > 0 的值,否则被动异常节点将无法恢复。默认30秒。
示例值:30

UpstreamHealthCheckerReqHeaders

后端通道主动健康检查的请求头配置

被如下接口引用:CreateUpstream, ModifyUpstream。

名称 类型 必选 描述

UpstreamInfo

后端通道详细信息

被如下接口引用:DescribeUpstreams。

名称 类型 描述
UpstreamId String 后端通道唯一ID
示例值:upstream-xxxx
UpstreamName String 后端通道名字
示例值:test_upstream
UpstreamDescription String 后端通道描述
示例值:description
Scheme String 后端协议,取值范围:HTTP, HTTPS
示例值:HTTP
Algorithm String 负载均衡算法,取值范围:ROUND_ROBIN
示例值:ROUND_ROBIN
UniqVpcId String VPC唯一ID
示例值:vpc-123456
Retries Integer 请求重试次数
示例值:3
Nodes Array of UpstreamNode 后端节点
示例值:x x
CreatedTime Timestamp ISO8601 创建时间
示例值:x x
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。
HealthChecker UpstreamHealthChecker 健康检查配置
注意:此字段可能返回 null,表示取不到有效值。
UpstreamType String 后端的类型,取值范围:IP_PORT, K8S
示例值:K8S
K8sServices Array of K8sService K8S容器服务配置
注意:此字段可能返回 null,表示取不到有效值。
UpstreamHost String 网关转发给后端的Host请求头
注意:此字段可能返回 null,表示取不到有效值。

UpstreamNode

后端通道后端节点元数据

被如下接口引用:CreateUpstream, DescribeUpstreams, ModifyUpstream。

名称 类型 必选 描述
Host String IP或域名
示例值:1.1.1.1
Port Integer 端口[0, 65535]
示例值:22
Weight Integer 权重[0, 100], 0为禁用
示例值:10
VmInstanceId String CVM实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:ins-123456
Tags Array of String 染色标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:["release","test"]
Healthy String 节点健康状态,创建、编辑时不需要传该参数。OFF:关闭,HEALTHY:健康,UNHEALTHY:异常,NO_DATA:数据未上报。目前只支持VPC通道。
注意:此字段可能返回 null,表示取不到有效值。
示例值:OFF
ServiceName String K8S容器服务名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:web
NameSpace String K8S命名空间
注意:此字段可能返回 null,表示取不到有效值。
示例值:Default
ClusterId String TKE集群的ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cls-xxxx
Source String Node的来源,取值范围:K8S
注意:此字段可能返回 null,表示取不到有效值。
示例值:K8S
UniqueServiceName String API网关内部记录唯一的服务名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:/upstream-xxxx/cls-xxx/default/web

UsagePlan

usagePlan详情

被如下接口引用:DescribeService, DescribeServiceForApiApp。

名称 类型 描述
Environment String 环境名称。
UsagePlanId String 使用计划唯一ID。
UsagePlanName String 使用计划名称。
UsagePlanDesc String 使用计划描述。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec Integer 使用计划qps,-1表示没有限制。
CreatedTime Timestamp ISO8601 使用计划时间。
ModifiedTime Timestamp ISO8601 使用计划修改时间。

UsagePlanBindEnvironment

使用计划绑定环境信息

被如下接口引用:CreateUsagePlan, DescribeUsagePlan, ModifyUsagePlan。

名称 类型 描述
EnvironmentName String 环境名。
注意:此字段可能返回 null,表示取不到有效值。
ServiceId String 服务唯一ID。
注意:此字段可能返回 null,表示取不到有效值。

UsagePlanBindSecret

使用计划绑定密钥

被如下接口引用:DescribeUsagePlanSecretIds。

名称 类型 描述
AccessKeyId String 密钥ID。
注意:此字段可能返回 null,表示取不到有效值。
SecretName String 密钥名称。
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 密钥状态,0表示已禁用,1表示启用中。
注意:此字段可能返回 null,表示取不到有效值。

UsagePlanBindSecretStatus

使用计划绑定密钥列表

被如下接口引用:DescribeUsagePlanSecretIds。

名称 类型 描述
TotalCount Integer 使用计划绑定密钥的数量。
注意:此字段可能返回 null,表示取不到有效值。
AccessKeyList Array of UsagePlanBindSecret 密钥详情列表。
注意:此字段可能返回 null,表示取不到有效值。

UsagePlanEnvironment

使用计划绑定环境详情。

被如下接口引用:DescribeUsagePlanEnvironments。

名称 类型 描述
ServiceId String 绑定的服务唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiId String API 的唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
ApiName String API 的名称。
注意:此字段可能返回 null,表示取不到有效值。
Path String API 的路径。
注意:此字段可能返回 null,表示取不到有效值。
Method String API 的方法。
注意:此字段可能返回 null,表示取不到有效值。
Environment String 已经绑定的环境名称。
注意:此字段可能返回 null,表示取不到有效值。
InUseRequestNum Integer 已经使用的配额。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum Integer 最大请求量。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec Integer 每秒最大请求次数。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ServiceName String 服务名称。
注意:此字段可能返回 null,表示取不到有效值。

UsagePlanEnvironmentStatus

使用计划绑定环境的列表。

被如下接口引用:DescribeUsagePlanEnvironments。

名称 类型 描述
TotalCount Integer 使用计划绑定的服务的环境数。
注意:此字段可能返回 null,表示取不到有效值。
EnvironmentList Array of UsagePlanEnvironment 使用计划已经绑定的各个服务的环境状态。
注意:此字段可能返回 null,表示取不到有效值。

UsagePlanInfo

使用计划详情。

被如下接口引用:CreateUsagePlan, DescribeUsagePlan, ModifyUsagePlan。

名称 类型 描述
UsagePlanId String 使用计划唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanName String 使用计划名称。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanDesc String 使用计划描述。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec Integer 每秒请求限制数。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum Integer 最大调用次数。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
BindSecretIdTotalCount Integer 绑定密钥的数量。
注意:此字段可能返回 null,表示取不到有效值。
BindSecretIds Array of String 绑定密钥的详情。
注意:此字段可能返回 null,表示取不到有效值。
BindEnvironmentTotalCount Integer 绑定环境数量。
注意:此字段可能返回 null,表示取不到有效值。
BindEnvironments Array of UsagePlanBindEnvironment 绑定环境详情。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。

UsagePlanStatusInfo

用于使用计划列表展示

被如下接口引用:DescribeUsagePlansStatus。

名称 类型 描述
UsagePlanId String 使用计划唯一 ID。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanName String 用户自定义的使用计划名称。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanDesc String 用户自定义的使用计划描述。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNumPreSec Integer 每秒最大请求次数。
注意:此字段可能返回 null,表示取不到有效值。
MaxRequestNum Integer 请求配额总量,-1表示没有限制。
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
ModifiedTime Timestamp ISO8601 最后修改时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。

UsagePlansStatus

使用计划列表

被如下接口引用:DescribeUsagePlansStatus。

名称 类型 描述
TotalCount Integer 符合条件的使用计划数量。
注意:此字段可能返回 null,表示取不到有效值。
UsagePlanStatusSet Array of UsagePlanStatusInfo 使用计划列表。
注意:此字段可能返回 null,表示取不到有效值。

VpcConfig

独享实例vpc配置信息

被如下接口引用:DescribeExclusiveInstanceDetail, ModifyExclusiveInstance。

名称 类型 必选 描述
UniqVpcId String vpcid
示例值:vpc-12345
UniqSubnetId String subnetid
示例值:subnet-12345