租户端 互联网中间件 API网关（APIGW） 数据结构

数据结构

最近更新时间: 2024-10-18 10:38:33

AccountUsageSecretIdCount

密钥使用计数

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
SecretIdCount 是 否 Int64 密钥使用计数

AccountUsageServiceCount

已使用的计数

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
ServiceCount 是 否 Int64 服务数量

CloudNativeAPIGatewaySystemParameterReq

云原生API网关实例系统参数请求信息。

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 是 否 String 参数名。
Value 是 否 String 参数值。

CloudNativeAPIGatewayClsConfig

云原生API网关实例关联的CLS配置信息。

被如下接口引用：

名称 必选 允许NULL 类型 描述
LogsetId 是 否 String CLS日志集ID。
TopicId 是 否 String CLS主题ID。
LogType 是 否 String 日志类型, KongErrorLog|KongAccessLog。

AttachedPluginSummary

已绑定的插件信息。

被如下接口引用：DescribePluginsByApi

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 已绑定的插件总数。
PluginSummary 是 否 Array of AttachedPluginInfo 已绑定的插件信息。

DescribeCloudNativeAPIGatewayClsConfigResult

获取云原生API网关实例关联的CLS配置信息响应结果。

被如下接口引用：

名称 必选 允许NULL 类型 描述
GatewayId 是 否 String 云原生网关实例ID。
ClsConfigList 是 否 Array of CloudNativeAPIGatewayClsConfig CLS配置信息列表。

PriceInfos

apigateway询价结果

被如下接口引用：InquiryPrice

名称 必选 允许NULL 类型 描述
UnitPrice 是 是 String 计费单位价格（元）
ChargeUnit 是 是 String 计费单位周期

ApiAppApiInfo

应用绑定的Api信息

被如下接口引用：DescribeApiAppBindApisStatus、DescribeApiBindApiAppsStatus

名称 必选 允许NULL 类型 描述
ApiAppName 是 是 String 应用名称
ApiAppId 是 否 String 应用ID
ApiId 是 是 String Api的ID
ApiName 是 是 String Api名称
ServiceId 是 是 String 服务ID
AuthorizedTime 是 是 Datetime_iso 授权绑定时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ApiRegion 是 是 String Api所属地域
EnvironmentName 是 是 String 授权绑定的环境

ServiceParameter

ServiceParameter

被如下接口引用：CreateApi、DescribeApi、DescribeApiForApiApp、ModifyApi

名称 必选 允许NULL 类型 描述
Name 否 是 String API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。
Position 否 是 String API 的后端服务参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。
RelevantRequestParameterPosition 否 是 String API 的后端服务参数对应的前端参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。
RelevantRequestParameterName 否 是 String API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
DefaultValue 否 是 String API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。
RelevantRequestParameterDesc 否 是 String API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。
RelevantRequestParameterType 否 是 String API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。

CloudNativeAPIGatewayConfig

云原生API网关配置信息。

被如下接口引用：

名称 必选 允许NULL 类型 描述
ConsoleType 是 否 String 控制台类型。
HttpUrl 是 是 String HTTP链接地址。
HttpsUrl 是 否 String HTTPS链接地址。
NetType 是 否 String 网络类型, Open|Internal。
AdminUser 是 是 String 管理员用户名。
AdminPassword 是 是 String 管理员密码。

ResourcePackSetList

资源包具体信息

被如下接口引用：DescribeResourcePackStatus

名称 必选 允许NULL 类型 描述
ResourceId 是 否 String 资源包id
Region 是 否 String 地域，默认是广州，表示全地域通用
Origin 是 否 String 资源包来源, free：免费包，activity：运营包
Used 是 否 String 资源包已使用量，保留4位小数，succ_req的单位是万次，out_traffic的单位是GB
Total 是 否 String 资源包总量，保留4位小数，单位同上
GoodsType 是 否 String 资源包类型，succ_req：调用次数，out_traffic：出流量，不传表示所有类型
GoodsStatus 是 否 String 资源包状态，valid：有效，exhaust：资源耗尽，expire：资源包到期，isolated: 被隔离，后面3种都是失效状态，不传表示所有类型
CreateTime 是 否 String 资源包创建时间
EnableTime 是 否 String 资源包生效时间
ExpireTime 是 否 String 资源包到期时间
AllowReturn 是 否 Bool 是否允许退费
DealName 是 否 String 订单号

AttachedApiSummary

插件绑定的API列表

被如下接口引用：DescribePluginApis

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 插件绑定的API数量。
AttachedApis 是 否 Array of AttachedApiInfo 插件绑定的API信息。

ApiIdStatus

API状态

被如下接口引用：DescribeService、DescribeServiceForApiApp

名称 必选 允许NULL 类型 描述
ServiceId 是 否 String 服务唯一ID。
ApiId 是 否 String API唯一ID。
ApiDesc 是 否 String API描述
Path 是 否 String API PATH。
Method 是 否 String API METHOD。
CreatedTime 是 否 Datetime_iso 服务创建时间。
ModifiedTime 是 否 Datetime_iso 服务修改时间。
ApiName 是 是 String API名称。
UniqVpcId 是 是 String VPC唯一ID。
ApiType 是 是 String API类型。
Protocol 是 是 String API协议。
IsDebugAfterCharge 是 是 Bool 是否买后调试。
AuthType 是 是 String 授权类型。
ApiBusinessType 是 是 String API业务类型。
AuthRelationApiId 是 是 String 关联授权API唯一ID。
RelationBuniessApiIds 是 是 Array of String 授权API关联的业务API列表。
OauthConfig 是 是 OauthConfig oauth配置信息。
TokenLocation 是 是 String oauth2.0API请求，token存放位置。

DescribeUpstreamInfo

查询vpc通道返回信息

被如下接口引用：DescribeUpstreams

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Uint64 查询总数
UpstreamSet 是 否 Array of UpstreamInfo 查询列表

MicroService

API绑定的微服务信息。

被如下接口引用：DescribeApi、DescribeApiForApiApp

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

ApiUsagePlan

api或service绑定使用计划详情

被如下接口引用：DescribeApiUsagePlan、DescribeServiceUsagePlan

名称 必选 允许NULL 类型 描述
ServiceId 是 是 String 服务唯一ID。
ApiId 是 是 String API 唯一 ID。
ApiName 是 是 String API 名称。
Path 是 是 String API 路径。
Method 是 是 String API 方法。
UsagePlanId 是 是 String 使用计划的唯一 ID。
UsagePlanName 是 是 String 使用计划的名称。
UsagePlanDesc 是 是 String 使用计划的描述。
Environment 是 是 String 使用计划绑定的服务环境。
InUseRequestNum 是 是 Int64 已经使用的配额。
MaxRequestNum 是 是 Int64 请求配额总量，-1表示没有限制。
MaxRequestNumPreSec 是 是 Int64 请求 QPS 上限，-1 表示没有限制。
CreatedTime 是 是 Datetime_iso 使用计划创建时间。
ModifiedTime 是 是 Datetime_iso 使用计划最后修改时间。
ServiceName 是 是 String 服务名称。

DescribeCloudNativeAPIGatewayResult

获取云原生API网关基础信息响应结果。

被如下接口引用：

名称 必选 允许NULL 类型 描述
GatewayId 是 否 String 云原生API网关ID。
Status 是 否 String 云原生API网关状态。
Zone 是 否 String 云原生API网关所属可用区。
Name 是 否 String 云原生API网关名。
Type 是 否 String 云原生API网关类型。
GatewayVersion 是 否 String 云原生API网关版本。
NodeConfig 是 否 CloudNativeAPIGatewayNodeConfig 云原生API网关节点信息。
VpcConfig 是 否 CloudNativeAPIGatewayVpcConfig 云原生API网关vpc配置。
Description 是 否 String 云原生API网关描述。
CreateTime 是 否 Datetime 云原生API网关创建时间。

LogQuery

检索条件入参

被如下接口引用：DescribeLogSearch

名称 必选 允许NULL 类型 描述
Name 是 否 String 检索字段
Operator 是 否 String 操作符
Value 是 否 String 检索值

Service

展示服务列表用

被如下接口引用：DescribeServicesStatus

名称 必选 允许NULL 类型 描述
InnerHttpsPort 是 是 Int64 内网访问https端口。
ServiceDesc 是 是 String 用户自定义的服务描述。
Protocol 是 是 String 服务的前端请求类型。如http、https 或者 http&https。
ModifiedTime 是 是 Datetime_iso 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
NetTypes 是 是 Array of String 服务支持的网络类型。
ExclusiveSetName 是 是 String 独占集群名称。
ServiceId 是 是 String 服务唯一 ID。
IpVersion 是 是 String IP版本。
AvailableEnvironments 是 是 Array of String 已经发布的环境列表。如test、prepub、release。
ServiceName 是 是 String 用户自定义的服务名称。
OuterSubDomain 是 是 String 系统为该服务分配的外网域名。
CreatedTime 是 是 Datetime_iso 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
InnerHttpPort 是 是 Uint64 内网访问http端口。
InnerSubDomain 是 是 String 系统为该服务自动分配的内网域名。
TradeIsolateStatus 是 是 Int64 服务的计费状态。
Tags 是 是 Array of Tag 服务绑定的标签
InstanceId 是 是 String 独享实例
SetType 是 是 String 集群类型
ProjectId 是 是 String 项目ID
TceArch 否 是 String CPU架构，可选项[arm, x86]

UsagePlanFilter

使用计划过滤条件

被如下接口引用：

名称 必选 允许NULL 类型 描述
UsagePlanId 否 否 String 使用计划id
UsagePlanName 否 否 String 使用计划名称
NotServiceId 否 否 String 非service id
NotApiId 否 否 String 非api id
Environment 否 否 String 环境

ApiEnvironmentApiKeys

api绑定密钥

被如下接口引用：DescribeApiEnvironmentApiKeys

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 API绑定密钥数量。
AccessKeyIdList 是 是 Array of String API绑定密钥列表。

LogRule

日志上报规则。

被如下接口引用：DescribeLogRules

名称 必选 允许NULL 类型 描述
LogRuleId 是 否 String 日志规则唯一ID。
ServiceId 是 否 String 服务唯一ID，ALL表示全部服务。
EnvironmentName 是 否 String 环境名称，ALL表示全部环境。
LogSetId 是 否 String 日志集ID。
TopicId 是 否 String 日志主题ID。
LogRuleName 是 否 String 日志规则名称
CreateTime 是 否 Datetime_iso 创建时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ServiceName 是 否 String 服务名称。

UpstreamInfo

VPC通道信息集合

被如下接口引用：DescribeUpstreams、ModifyUpstream

名称 必选 允许NULL 类型 描述
UpstreamId 是 否 String VPC通道唯一ID
UpstreamName 是 否 String VPC通道名字
UpstreamDescription 是 否 String VPC通道描述
Scheme 是 否 String 写意
Algorithm 是 否 String 负载均衡算法
UniqVpcId 是 否 String vpc唯一ID
Retries 是 否 Uint64 请求重拾次数
Nodes 是 否 Array of UpstreamNode 后端节点
CreatedTime 是 否 Datetime_iso 创建时间
Tags 是 是 Array of Tag 标签
HealthChecker 是 是 UpstreamHealthChecker 健康检查配置

ServiceUsagePlanSet

服务绑定使用计划列表

被如下接口引用：DescribeServiceUsagePlan

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 服务上绑定的使用计划总数。
ServiceUsagePlanList 是 是 Array of ApiUsagePlan 服务上绑定的使用计划列表。

UsagePlan

usagePlan详情

被如下接口引用：DescribeService、DescribeServiceForApiApp

名称 必选 允许NULL 类型 描述
Environment 是 否 String 环境名称。
UsagePlanId 是 否 String 使用计划唯一ID。
UsagePlanName 是 否 String 使用计划名称。
UsagePlanDesc 是 否 String 使用计划描述。
MaxRequestNumPreSec 是 否 Int64 使用计划qps，-1表示没有限制。
CreatedTime 是 否 Datetime_iso 使用计划时间。
ModifiedTime 是 否 Datetime_iso 使用计划修改时间。

CheckSet

返回Code + Msg

被如下接口引用：CheckCloneApis

名称 必选 允许NULL 类型 描述
CheckStatus 是 否 Int64 返回码 0 ok 非0 失败
CheckMessageList 是 否 Array of String 错误信息

Tag

API绑定的标签信息。

被如下接口引用：CreateApiApp、CreatePlugin、CreateService、CreateUpstream、DescribeApi、DescribeApiApp、DescribeApiAppsStatus、DescribeApiForApiApp、DescribeExclusiveInstanceDetail、DescribeExclusiveInstances、DescribePlugin、DescribePlugins、DescribeService、DescribeServiceForApiApp、DescribeServicesStatus、DescribeUpstreams、ModifyApi、ModifyExclusiveInstance、ModifyUpstream

名称 必选 允许NULL 类型 描述
Key 是 否 String 标签的 key。
Value 是 否 String 便签的 value。

InstanceChargePrepaid

独享实例预付费详情

被如下接口引用：DescribeExclusiveInstanceDetail、ModifyExclusiveInstance

名称 必选 允许NULL 类型 描述
RenewFlag 是 否 String 自动续费标示
ExpiredTime 是 否 Datetime_iso 预付费到期时间

Price

apigateway询价列表

被如下接口引用：InquiryPrice

名称 必选 允许NULL 类型 描述
RequestPrice 是 是 PriceInfos 请求数计费询价
BandwidthPrice 是 是 PriceInfos 流量计费询价

TsfLoadBalanceConfResp

TsfLoadBalanceConf 出参使用

被如下接口引用：CreateApi、DescribeApi、DescribeApiForApiApp、ModifyApi

名称 必选 允许NULL 类型 描述
IsLoadBalance 否 是 Bool 是否开启负载均衡。
Method 否 是 String 负载均衡方式。
SessionStickRequired 否 是 Bool 是否开启会话保持。
SessionStickTimeout 否 是 Int64 会话保持超时时间。

HealthCheckConf

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

被如下接口引用：CreateApi、DescribeApi、DescribeApiForApiApp、ModifyApi

名称 必选 允许NULL 类型 描述
IsHealthCheck 否 否 Bool 是否开启健康检查。
RequestVolumeThreshold 否 否 Int64 健康检查阈值。
SleepWindowInMilliseconds 否 否 Int64 窗口大小。
ErrorThresholdPercentage 否 否 Int64 阈值百分比。

UsagePlanInfo

使用计划详情。

被如下接口引用：CreateUsagePlan、DescribeUsagePlan、ModifyUsagePlan

名称 必选 允许NULL 类型 描述
UsagePlanId 是 是 String 使用计划唯一 ID。
UsagePlanName 是 是 String 使用计划名称。
UsagePlanDesc 是 是 String 使用计划描述。
InitQuota 是 是 Int64 初始化调用次数。
MaxRequestNumPreSec 是 是 Int64 每秒请求限制数。
MaxRequestNum 是 是 Int64 最大调用次数。
IsHide 是 是 Int64 是否隐藏。
CreatedTime 是 是 Datetime_iso 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ModifiedTime 是 是 Datetime_iso 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
BindSecretIdTotalCount 是 是 Int64 绑定密钥的数量。
BindSecretIds 是 是 Array of String 绑定密钥的详情。
BindEnvironmentTotalCount 是 是 Int64 绑定环境数量。
BindEnvironments 是 是 Array of UsagePlanBindEnvironment 绑定环境详情。

UpstreamHealthChecker

VPC通道健康检查参数配置

被如下接口引用：CreateUpstream、DescribeUpstreams、ModifyUpstream

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

AccountLimitSecretIdCount

密钥规则

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
SecretIdCount 是 否 Int64 密钥计数
UsagePlanCountForSecretId 是 否 Int64 密钥的使用计划

UpstreamHealthCheckerReqHeaders

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

被如下接口引用：CreateUpstream、DescribeUpstreams、ModifyUpstream

名称 必选 允许NULL 类型 描述
HeaderName 是 否 String 请求头名称
HeaderValue 是 否 String 请求头值

RequestConfig

前端路径配置

被如下接口引用：CheckServiceConfig、DescribeApi、DescribeApiForApiApp、ModifyApi

名称 必选 允许NULL 类型 描述
Path 是 否 String API 的路径，如 /path。
Method 是 否 String API 的请求方法，如 GET。

ApiInfoSummary

插件相关的API列表信息。

被如下接口引用：DescribeAllPluginApis、DescribeAvailablePluginApis

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 插件相关的API总数。
ApiSet 是 否 Array of AvailableApiInfo 插件相关的API信息。

ApiResponseTime

api响应时间

被如下接口引用：MonitorTops

名称 必选 允许NULL 类型 描述
ApiId 是 否 String api id
Path 是 否 String api 路径
ResponseTime 是 否 Uint64 响应时间（毫秒）
ServiceId 是 否 String 用户可读的服务id
ApiType 是 否 String api类型。

AccountUsageLogRuleClount

日志使用计数

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
LogRuleClount 是 否 Int64 日志使用计数

IPStrategyApiStatus

ip策略绑定api详情

被如下接口引用：DescribeIPStrategyApisStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 环境绑定API数量。
ApiIdStatusSet 是 是 Array of IPStrategyApi 环境绑定API详情。

CloudNativeAPIGatewayVpcConfig

云原生API网关vpc配置。

被如下接口引用：

名称 必选 允许NULL 类型 描述
VpcId 是 否 String 私有网络ID。
SubnetId 是 否 String 子网ID。

ListCloudNativeAPIGatewaySystemParametersResult

获取云原生API网关系统参数响应结果。

被如下接口引用：

名称 必选 允许NULL 类型 描述
GatewayId 是 否 String 云原生API网关实例ID。
TotalCount 是 否 Int64 云原生API网关系统参数数量。
SystemParameterList 是 否 Array of CloudNativeAPIGatewaySystemParameter 云原生API网关系统参数列表。

ApiTags

ApiTags

被如下接口引用：

名称 必选 允许NULL 类型 描述
Key 是 否 String 标签的key。
Values 是 否 Array of String 标签的values。

CloudNativeAPIGatewaySystemParameter

云原生API网关系统参数

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 是 否 String 参数名。
Value 是 否 String 参数内容。
DefaultValue 是 否 String 参数默认值。
ModifiableValue 是 否 String 参数可修改值。
NeedReload 是 否 Bool 是否需要重启生效。

DescribeCloudNativeAPIGatewayConfigResult

获取云原生API网关配置响应结果。

被如下接口引用：

名称 必选 允许NULL 类型 描述
GatewayId 是 否 String 云原生API网关ID。
ConfigList 是 否 Array of CloudNativeAPIGatewayConfig 云原生API网关配置列表。

Base64EncodedTriggerRule

Base64编码的header触发规则

被如下接口引用：DescribeApi、DescribeApiForApiApp、ModifyApi

名称 必选 允许NULL 类型 描述
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"] 等都是合法的。

MicroServiceReq

tsf类型入参

被如下接口引用：CreateApi、ModifyApi

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

Version

Version

被如下接口引用：

名称 必选 允许NULL 类型 描述
VersionName 是 否 String version id
VersionDesc 是 否 String version 描述
CreateTime 是 否 Datetime_iso 创建时间
Environments 是 否 Array of String 环境列表

PluginSummary

插件列表详情。

被如下接口引用：DescribePlugins

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 插件个数。
PluginSet 是 否 Array of Plugin 插件详情。

ServiceReleaseHistory

服务发布历史

被如下接口引用：DescribeServiceEnvironmentReleaseHistory

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 发布版本总数。
VersionList 是 是 Array of ServiceReleaseHistoryInfo 历史版本列表。

IPStrategysStatus

策略列表

被如下接口引用：DescribeIPStrategysStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 策略数量。
StrategySet 是 是 Array of IPStrategy 策略列表。

OauthConfig

Oauth授权配置信息

被如下接口引用：CreateApi、CreateIPStrategy、DescribeApi、DescribeApiForApiApp、DescribeApisStatus、DescribeEIAMApis、DescribeIPStrategy、DescribeIPStrategysStatus、DescribeService、DescribeServiceForApiApp、ModifyApi

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

ApiAppInfo

应用信息

被如下接口引用：CreateApiApp、DescribeApiApp、DescribeApiAppsStatus

名称 必选 允许NULL 类型 描述
ApiAppName 是 是 String 应用名称
ApiAppId 是 否 String 应用ID
ApiAppSecret 是 是 String 应用SECRET
ApiAppDesc 是 是 String 应用描述
CreatedTime 是 是 Datetime_iso 创建时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ModifiedTime 是 是 Datetime_iso 修改时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ApiAppKey 是 是 String 应用KEY
Tags 是 否 Array of Tag 标签
ProjectId 是 是 String 项目ID

ApiFilter

api过滤条件

被如下接口引用：

名称 必选 允许NULL 类型 描述
ApiPath 否 否 String api路径
ApiName 否 否 String api名称

ServiceReleaseVersion

服务发布版本

被如下接口引用：DescribeServiceReleaseVersion

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 发布版本总数量。
VersionList 是 是 Array of ServiceReleaseHistoryInfo 发布版本列表。

ApiKey

密钥详情

被如下接口引用：CreateApiKey、DescribeApiKey、DescribeApiKeysStatus、UpdateApiKey

名称 必选 允许NULL 类型 描述
AccessKeyId 是 否 String 创建的 API 密钥 ID 。
AccessKeySecret 是 否 String 创建的 API 密钥 Key。
AccessKeyType 是 否 String 密钥类型，auto 或者 manual。
SecretName 是 否 String 用户自定义密钥名称。
ModifiedTime 是 否 Datetime_iso 最后一次修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
Status 是 否 Int64 密钥状态。0表示禁用，1表示启用。
CreatedTime 是 否 Datetime_iso 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。

InstanceDetail

独享实例详情

被如下接口引用：DescribeExclusiveInstanceDetail、ModifyExclusiveInstance

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 独享实例唯一id
Zone 是 否 String 可用区
InstanceName 是 否 String 独享实例名字
InstanceDescription 是 否 String 独享实例描述
InstanceChargeType 是 否 String 独享实例计费类型
InstanceState 是 否 String 独享实例状态
InstanceChargePrepaid 是 是 InstanceChargePrepaid 独享实例预付费类型
InstanceType 是 否 String 独享实例类型
NetworkConfig 是 是 NetworkConfig 独享实例网络类型
VpcConfig 是 否 VpcConfig 独享实例vpc配置
Parameters 是 是 Array of ParameterInfo 独享实例参数配置
IsolationStartedTime 是 否 Datetime_iso 独享实例隔离时间
CreatedTime 是 否 Datetime_iso 创建时间
DealName 是 是 String 订单号
Zones 是 是 String 可用区列表
Tags 是 是 Array of Tag 标签

UsagePlanBindSecret

使用计划绑定密钥

被如下接口引用：DescribeUsagePlanSecretIds

名称 必选 允许NULL 类型 描述
AccessKeyId 是 是 String 密钥ID。
SecretName 是 是 String 密钥名称。
Status 是 是 Int64 密钥状态，0表示已禁用，1表示启用中。

ServiceFilter

service过滤参数

被如下接口引用：

名称 必选 允许NULL 类型 描述
ServiceId 否 否 String 服务唯一id
ServiceName 否 否 String 服务名称
NotUsagePlanId 否 否 String 没有绑定的使用计划
Environments 否 否 String 环境
IpVersion 否 否 String ip版本

ServiceSubDomainMappings

服务自定义域名路径映射

被如下接口引用：DescribeServiceSubDomainMappings

名称 必选 允许NULL 类型 描述
IsDefaultMapping 是 否 Bool 是否使用默认路径映射，为 True 表示使用默认路径映射；为 False 的话，表示使用自定义路径映射，此时 PathMappingSet 不为空。
PathMappingSet 是 否 Array of PathMapping 自定义路径映射列表。

ApiAppInfos

应用信息集

被如下接口引用：DescribeApiApp、DescribeApiAppsStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 应用数量
ApiAppSet 是 是 Array of ApiAppInfo 应用信息数组

CreateCloudNativeAPIGatewayResult

创建云原生API网关响应结果。

被如下接口引用：

名称 必选 允许NULL 类型 描述
GatewayId 是 否 String 云原生API网关ID。
Status 是 否 String 云原生网关状态。

VpcConfig

独享实例vpc配置信息

被如下接口引用：DescribeExclusiveInstanceDetail、ModifyExclusiveInstance

名称 必选 允许NULL 类型 描述
UniqVpcId 是 否 String vpcid
UniqSubnetId 是 否 String subnetid

ServiceReqCount

服务的请求数

被如下接口引用：MonitorTops

名称 必选 允许NULL 类型 描述
ServiceId 是 否 String 用户服务id
ServiceName 是 否 String 服务名字
ReqCount 是 否 Uint64 请求数

AccountSettings

用户配额详情

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
AccountLimit 是 否 Limit 用户配额
AccountUsage 是 否 Usage 使用量

UsagePlanEnvironmentStatus

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

被如下接口引用：DescribeUsagePlanEnvironments

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 使用计划绑定的服务的环境数。
EnvironmentList 是 是 Array of UsagePlanEnvironment 使用计划已经绑定的各个服务的环境状态。

AccountLimitServiceCount

服务规则

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
ServiceCount 是 否 Int64 服务数量
ApiCountInService 是 否 Int64 服务的api数量
DomainCountInService 是 否 Int64 服务的自定义域名数量

CreateApiRspSet

CreateApiRsp 返回加TotalCount

被如下接口引用：ImportOpenApi

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Uint64 个数
ApiSet 是 否 Array of CreateApiRsp 返回的数组

EnvironmentList

查询服务的环境是否进行key维度的监控数据上报

被如下接口引用：DescribeServiceEnvironmentKeyMonitorUpload

名称 必选 允许NULL 类型 描述
TotolCount 是 否 Int64 总数
EnvironmentSet 是 否 Array of EnvironmentUpload 服务的环境列表

IPStrategy

ip策略

被如下接口引用：CreateIPStrategy、DescribeIPStrategy、DescribeIPStrategysStatus

名称 必选 允许NULL 类型 描述
StrategyId 是 是 String 策略唯一ID。
StrategyName 是 是 String 用户自定义策略名称。
StrategyType 是 是 String 策略类型。支持WHITE（白名单）和BLACK（黑名单）。
StrategyData 是 是 String IP列表。
CreatedTime 是 是 Datetime_iso 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ModifiedTime 是 是 Datetime_iso 修改时间。
ServiceId 是 是 String 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
BindApiTotalCount 是 是 Int64 策略绑定的API数量。
BindApis 是 是 Array of DesApisStatus 绑定的API详情。

ServicesStatus

服务列表展示

被如下接口引用：DescribeServicesStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 服务列表总数。
ServiceSet 是 是 Array of Service 服务列表详情。

ResourcePackResult

资源包信息

被如下接口引用：DescribeResourcePackStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Uint64 资源包数量
ResourcePackSet 是 否 Array of ResourcePackSetList 资源包具体信息

CloudNativeAPIGatewayNodeConfig

云原生API网关节点配置。

被如下接口引用：

名称 必选 允许NULL 类型 描述
Specification 是 否 String 节点配置, 1c2g|2c4g|4c8g|8c16g。
Number 是 否 Int64 节点数量，2-9。

APIDocs

API文档列表

被如下接口引用：DescribeAPIDocs

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 API文档数量
APIDocSet 是 否 Array of APIDoc API文档基本信息

ConstantParameter

常量参数

被如下接口引用：CreateApi、DescribeApi、DescribeApiForApiApp、ModifyApi

名称 必选 允许NULL 类型 描述
Name 否 否 String 常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。
Desc 否 否 String 常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。
Position 否 否 String 常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。
DefaultValue 否 否 String 常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。

APIDoc

API文档基本信息

被如下接口引用：CreateAPIDoc、DescribeAPIDocs、ModifyAPIDoc、ResetAPIDocPassword

名称 必选 允许NULL 类型 描述
ApiDocId 是 否 String API文档ID
ApiDocName 是 否 String API文档名称
ApiDocStatus 是 否 String API文档构建状态

EnvironmentUpload

服务的环境是否进行key维度的监控数据上报

被如下接口引用：DescribeServiceEnvironmentKeyMonitorUpload、ModifyServiceEnvironmentKeyMonitorUpload

名称 必选 允许NULL 类型 描述
EnvironmentName 是 否 String 环境
IsUpdate 是 否 Bool 是否上报

TcbScfApi

TCB-SCF-HTTP触发器API

被如下接口引用：DescribeTcbScfApis

名称 必选 允许NULL 类型 描述
EnvironmentId 是 否 String 环境ID。
ScfFunctionName 是 否 String SCF方法名称。
ScfFunctionNamespace 是 否 String SCF方法命名空间。
SubDomain 是 否 String 自定义子域名。
Path 是 否 String 请求Path。

ApiGatewayLog

日志信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
LogData 是 否 String log_format '[$app_id][$env_name][$service_id][$http_host][$api_id][$uri][$scheme][rsp_st:$status][ups_st:$upstream_status]''[cip:$remote_addr][uip:$upstream_addr][vip:$server_addr][rsp_len:$bytes_sent][req_len:$request_length]' '[req_t:$request_time][ups_rsp_t:$upstream_response_time][ups_conn_t:$upstream_connect_time][ups_head_t:$upstream_header_time]''[err_msg:$err_msg][tcp_rtt:$tcpinfo_rtt][$pid][$time_local]';app_id： 用户 ID。env_name：环境名称。service_id： 服务 ID。http_host： 域名。api_id： API 的 ID。uri：请求的路径。scheme： HTTP/HTTPS 协议。rsp_st： 请求响应状态码。ups_st： 后端业务服务器的响应状态码（如果请求透传到后端，改变量不为空。如果请求在 APIGW 就被拦截了，那么该变量显示为 -）。cip： 客户端 IP。uip： 后端业务服务（upstream）的 IP。vip： 请求访问的 VIP。rsp_len： 响应长度。req_len： 请求长度。req_t： 请求响应的总时间。ups_rsp_t： 后端响应的总时间（apigw 建立连接到接收到后端响应的时间）。ups_conn_t: 与后端业务服务器连接建立成功时间。ups_head_t：后端响应的头部到达时间。err_msg： 错误信息。tcp_rtt： 客户端 TCP 连接信息，RTT（Round Trip Time）由三部分组成：链路的传播时间（propagation delay）、末端系统的处理时间、路由器缓存中的排队和处理时间（queuing delay）。

DescribeUpstreamBindApis

查询vpc通道绑定api列表

被如下接口引用：DescribeUpstreamBindApis

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Uint64 总数
BindApiSet 是 否 Array of BindApiInfo 绑定的api信息

Environment

服务发布的环境信息。

被如下接口引用：DescribeServiceEnvironmentList

名称 必选 允许NULL 类型 描述
EnvironmentName 是 否 String 环境名称。
Url 是 否 String 访问路径。
Status 是 否 Uint64 发布状态，1 表示已发布，0 表示未发布。
VersionName 是 否 String 运行版本。

TriggerInfo

API网关触发器信息

被如下接口引用：UnbindTriggers

名称 必选 允许NULL 类型 描述
ResourceId 是 否 String API网关资源描述六段式
Qualifier 是 否 String 云函数版本信息

DesApisStatus

api状态详情

被如下接口引用：CreateIPStrategy、DescribeApisStatus、DescribeEIAMApis、DescribeIPStrategy、DescribeIPStrategysStatus

名称 必选 允许NULL 类型 描述
ServiceId 是 否 String 服务唯一ID。
ApiId 是 否 String API唯一ID。
ApiDesc 是 是 String 用户自定义的 API 接口描述。
CreatedTime 是 是 Datetime_iso 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ModifiedTime 是 是 Datetime_iso 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ApiName 是 是 String API 接口的名称。
VpcId 是 是 Int64 VPCID。
UniqVpcId 是 是 String VPC唯一ID。
ApiType 是 是 String API类型。取值为NORMAL（普通API）和TSF（微服务API）。
Protocol 是 是 String API协议。
IsDebugAfterCharge 是 是 Bool 是否买后调试。（云市场预留字段）
AuthType 是 是 String API 鉴权类型。取值为SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH、EIAM。
ApiBusinessType 是 是 String OAUTH API的类型。当AuthType 为 OAUTH时该字段有效， 取值为NORMAL（业务API）和 OAUTH（授权API）。
AuthRelationApiId 是 是 String 关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。
OauthConfig 是 是 OauthConfig OAUTH 配置信息。当AuthType是OAUTH时生效。
RelationBuniessApiIds 是 是 Array of String 授权API关联的业务API列表。
Tags 是 是 Array of String API关联的标签信息。
Path 是 是 String API 的路径，如 /path。
Method 是 是 String API 的请求方法，如 GET。
EIAMAppId 是 是 String EIAM 应用ID。

AccountLimitLogRuleClount

日志规则

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
LogRuleClount 是 否 Int64 日志规则

ReleaseService

发布服务返回

被如下接口引用：ReleaseService

名称 必选 允许NULL 类型 描述
ReleaseDesc 是 是 String 发布时的备注信息填写。
ReleaseVersion 是 是 String 发布的版本id。

DocumentSDK

api文档下载

被如下接口引用：GenerateApiDocument

名称 必选 允许NULL 类型 描述
DocumentURL 是 否 String 生成的 document 会存放到 COS 中，此出参返回产生文件的下载链接。
SdkURL 是 否 String 生成的 SDK 会存放到 COS 中，此出参返回产生 SDK 文件的下载链接。

PathMapping

自定义域名的路径映射。

被如下接口引用：BindSubDomain、DescribeServiceSubDomainMappings、ModifySubDomain

名称 必选 允许NULL 类型 描述
Path 是 否 String 路径。
Environment 是 否 String 发布环境，可选值为“test”、 ”prepub“、”release“。

UsagePlanStatusInfo

用于使用计划列表展示

被如下接口引用：DescribeUsagePlansStatus

名称 必选 允许NULL 类型 描述
UsagePlanId 是 是 String 使用计划唯一 ID。
UsagePlanName 是 是 String 用户自定义的使用计划名称。
UsagePlanDesc 是 是 String 用户自定义的使用计划描述。
MaxRequestNumPreSec 是 是 Int64 每秒最大请求次数。
MaxRequestNum 是 是 Int64 请求配额总量，-1表示没有限制。
CreatedTime 是 是 Datetime_iso 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ModifiedTime 是 是 Datetime_iso 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。

ApiEnvironmentStrategy

api环境绑定策略

被如下接口引用：DescribeApiEnvironmentStrategy

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

ServiceEnvironmentStrategy

服务环境策略

被如下接口引用：DescribeServiceEnvironmentStrategy

名称 必选 允许NULL 类型 描述
EnvironmentName 是 否 String 环境名。
Url 是 否 String 访问服务对应环境的url。
Status 是 否 Int64 发布状态。
VersionName 是 是 String 发布的版本号。
Strategy 是 否 Int64 限流值。
MaxStrategy 是 是 Int64 最大限流值

ServiceReleaseHistoryInfo

服务发布列表详情

被如下接口引用：DescribeServiceEnvironmentReleaseHistory、DescribeServiceReleaseVersion

名称 必选 允许NULL 类型 描述
VersionName 是 是 String 版本号。
VersionDesc 是 是 String 版本描述。
ReleaseTime 是 是 String 版本发布时间。

UsagePlansStatus

使用计划列表

被如下接口引用：DescribeUsagePlansStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 符合条件的使用计划数量。
UsagePlanStatusSet 是 是 Array of UsagePlanStatusInfo 使用计划列表。

InstanceParameterInput

独享实例参数信息

被如下接口引用：ModifyExclusiveInstance

名称 必选 允许NULL 类型 描述
Name 是 否 String ServiceRequestNumPreSec，ApiRequestNumPreSec
Value 是 否 String 参数值

ExclusiveSetList

独占集群

被如下接口引用：DescribeExclusiveSet

名称 必选 允许NULL 类型 描述
TotolCount 是 否 Int64 返回总数
ExclusiveSet 是 否 Array of ExclusiveSet 独占集群列表

AccountLimitUsagePlanCount

使用计划规则

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
UsagePlanCount 是 否 Int64 使用计划数量
SecretIdCountInUsagePlan 是 否 Int64 密钥使用计划
MaxQPSInUsagePlan 是 否 Int64 QPS使用计划
StageCountInUsagePlan 是 否 Int64 阶段计数使用计划

ApiUsagePlanSet

api绑定使用计划列表

被如下接口引用：DescribeApiUsagePlan

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 API 绑定的使用计划总数。
ApiUsagePlanList 是 是 Array of ApiUsagePlan API 绑定使用计划列表。

TsfLoadBalanceConfReq

TsfLoadBalanceConf 入参

被如下接口引用：

名称 必选 允许NULL 类型 描述
Method 否 否 String 方法
SessionStickRequired 否 否 Bool 是否会话保持
SessionStickTimeout 否 否 Int64 会话保持超时时间

KV

kv类型的参数

被如下接口引用：

名称 必选 允许NULL 类型 描述
Name 是 否 String 参数名
Value 是 否 String 参数值

ExclusiveSet

查询独立集群列表

被如下接口引用：DescribeExclusiveSet

名称 必选 允许NULL 类型 描述
ExclusiveSetName 是 否 String 集群名字
ExclusiveStatus 是 否 String 集群状态

ApiKeysStatus

密钥列表

被如下接口引用：DescribeApiKeysStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 符合条件的 API 密钥数量。
ApiKeySet 是 是 Array of ApiKey API 密钥列表。

ApiReqCount

api的请求数

被如下接口引用：MonitorTops

名称 必选 允许NULL 类型 描述
ApiId 是 否 String 用户的api id
Path 是 否 String api的路径
ReqCount 是 否 Uint64 请求数
ServiceId 是 否 String 用户可读的服务id
ApiType 是 否 String api类型。

DomainSets

自定义服务域名展示

被如下接口引用：DescribeServiceSubDomains

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 服务下的自定义域名数量。
DomainSet 是 否 Array of DomainSetList 自定义服务域名列表。

AvailableApiInfo

插件相关的API信息。

被如下接口引用：DescribeAllPluginApis、DescribeAvailablePluginApis

名称 必选 允许NULL 类型 描述
ApiId 是 否 String API ID。
ApiName 是 否 String API名称。
ApiType 是 否 String API类型。
Path 是 否 String API路径。
Method 是 否 String API方法。
AttachedOtherPlugin 是 是 Bool API是否绑定其他插件。
IsAttached 是 是 Bool API是否绑定当前插件。

TargetLoadBalanceConfReq

target lb配置

被如下接口引用：

名称 必选 允许NULL 类型 描述
Method 否 否 String 方法
SessionStickRequired 否 否 Bool 是否会话保持
SessionStickTimeout 否 否 Int64 会话保持超时时间

DomainSetList

服务自定义域名列表

被如下接口引用：DescribeServiceSubDomains

名称 必选 允许NULL 类型 描述
DomainName 是 否 String 域名名称。
Status 是 否 Int64 域名解析状态。1 表示正常解析，0 表示解析失败。
CertificateId 是 否 String 证书ID。
IsDefaultMapping 是 否 Bool 是否使用默认路径映射。
Protocol 是 否 String 自定义域名协议类型。
NetType 是 否 String 网络类型（'INNER' 或 'OUTER'）。
IsForcedHttps 是 否 Bool 是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。
RegistrationStatus 是 否 Bool 域名备案注册状态

ApiRequestConfig

api请求配置

被如下接口引用：CreateApi

名称 必选 允许NULL 类型 描述
Path 是 否 String path
Method 是 否 String 方法

ApisStatus

描述api列表状态

被如下接口引用：DescribeApisStatus、DescribeEIAMApis

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 符合条件的 API 接口数量。
ApiIdStatusSet 是 否 Array of DesApisStatus API 接口列表。

Api

api详情

被如下接口引用：

名称 必选 允许NULL 类型 描述
ServiceId 是 否 String 服务唯一ID。
ApiId 是 否 String API唯一ID。
ApiDesc 是 是 String API描述
Path 是 否 String API PATH。
Method 是 否 String API METHOD。
CreatedTime 是 否 Datetime_iso 服务创建时间。
ModifiedTime 是 否 Datetime_iso 服务修改时间。
ApiName 是 否 String API名称。
VpcId 是 是 Int64 VPCID。
UniqVpcId 是 是 String VPC唯一ID。
ApiType 是 是 String API类型。
Protocol 是 是 String API协议。
IsDebugAfterCharge 是 是 String 是否买后调试。
AuthType 是 是 String 授权类型。
ApiBuniessType 是 是 String API业务类型。
AuthRelationApiId 是 是 String 关联授权API唯一ID。
AuthRequired 是 是 String 是否需要鉴权。
OauthConfig 是 是 OauthConfig oauth配置信息。
TokenLocation 是 是 String oauth2.0API请求，token存放位置。
RelationBuniessApiIds 是 是 Array of String 授权API关联的业务API列表。

Usage

已使用量

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
ServiceCount 是 否 AccountUsageServiceCount 服务使用量
UsagePlanCount 是 否 AccountUsageUsagePlanCount 使用计划使用量
SecretIdCount 是 否 AccountUsageSecretIdCount 密钥使用量
LogRuleClount 是 否 AccountUsageLogRuleClount 日志使用量

Limit

使用配额

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
LogRuleClount 是 否 AccountLimitLogRuleClount 日志规则配额
ServiceCount 是 否 AccountLimitServiceCount 服务配额
UsagePlanCount 是 否 AccountLimitUsagePlanCount 使用计划配额
SecretIdCount 是 否 AccountLimitSecretIdCount 密钥配额

AccountUsageUsagePlanCount

已使用的使用计划

被如下接口引用：GetAccountSettings

名称 必选 允许NULL 类型 描述
UsagePlanCount 是 否 Int64 使用计划计数

BindApiInfo

vpc通道绑定的api信息

被如下接口引用：DescribeUpstreamBindApis

名称 必选 允许NULL 类型 描述
ApiId 是 否 String api唯一id
ServiceId 是 否 String Service唯一id
ApiName 是 是 String api名字
ServiceName 是 是 String 服务名字
BindTime 是 否 Datetime_iso 绑定时间

AdminInfo

服务的admin信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
VipgroupId 是 否 Uint64 vip组id
SetId 是 否 Uint64 集群id
NetType 是 否 String 服务的内外网信息
LdList 是 否 Array of String 服务对应的ld信息
VipList 是 否 Array of String 服务对应的vip信息

ReqParameter

请求参数

被如下接口引用：DescribeApi、DescribeApiForApiApp、ModifyApi

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

AttachedApiInfo

插件绑定的API信息

被如下接口引用：CreatePlugin、DescribePlugin、DescribePluginApis、DescribePlugins

名称 必选 允许NULL 类型 描述
ServiceId 是 否 String API所在服务ID。
ServiceName 是 否 String API所在服务名称。
ServiceDesc 是 是 String API所在服务描述信息。
ApiId 是 否 String API ID。
ApiName 是 否 String API名称。
ApiDesc 是 是 String API描述。
Environment 是 否 String 插件绑定API的环境。
AttachedTime 是 否 Datetime_iso 插件和API绑定时间。

IPStrategyFilter

策略过滤条件

被如下接口引用：

名称 必选 允许NULL 类型 描述
IPStrategyName 否 否 String 策略名称

ApiEnvironmentStrategyStataus

API绑定策略列表

被如下接口引用：DescribeApiEnvironmentStrategy

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 API绑定的限流策略数量。
ApiEnvironmentStrategySet 是 是 Array of ApiEnvironmentStrategy API绑定的限流策略列表。

ParameterInfo

独享实例配置参数

被如下接口引用：DescribeExclusiveInstanceDetail、ModifyExclusiveInstance

名称 必选 允许NULL 类型 描述
Name 是 否 String 名字
Value 是 否 Int64 当前值
Default 是 否 Int64 默认值
Unit 是 否 String 单位
Type 是 否 String 类型
Minimum 是 否 Int64 最小
Maximum 是 否 Int64 最大
ModifedTime 是 否 Datetime_iso 修改时间

UsagePlanEnvironment

使用计划绑定环境详情。

被如下接口引用：DescribeUsagePlanEnvironments

名称 必选 允许NULL 类型 描述
ServiceId 是 是 String 绑定的服务唯一 ID。
ApiId 是 是 String API 的唯一ID。
ApiName 是 是 String API 的名称。
Path 是 是 String API 的路径。
Method 是 是 String API 的方法。
Environment 是 是 String 已经绑定的环境名称。
InUseRequestNum 是 是 Int64 已经使用的配额。
MaxRequestNum 是 是 Int64 最大请求量。
MaxRequestNumPreSec 是 是 Int64 每秒最大请求次数。
CreatedTime 是 是 Datetime_iso 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ModifiedTime 是 是 Datetime_iso 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ServiceName 是 是 String 服务名称。

InstanceInfo

独享实例信息

被如下接口引用：DescribeExclusiveInstances

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 独享实例唯一id
InstanceName 是 否 String 独享实例name
InstanceDescription 是 否 String 独享实例描述
InstanceChargeType 是 否 String 独享实例计费类型
InstanceType 是 否 String 独享实例类型
InstanceState 是 否 String 独享实例状态
CreatedTime 是 否 Datetime_iso 独享实例创建时间
DealName 是 是 String 订单号
ResourceId 是 否 String 资源ID同唯一id
Tags 是 是 Array of Tag 标签

APIDocInfo

API文档详细信息

被如下接口引用：DescribeAPIDocDetail

名称 必选 允许NULL 类型 描述
ApiDocId 是 否 String API文档ID
ApiDocName 是 否 String API文档名称
ApiDocStatus 是 否 String API文档构建状态
ApiCount 是 否 Int64 API文档API数量
ViewCount 是 否 Int64 API文档查看次数
ReleaseCount 是 否 Int64 API文档发布次数
ApiDocUri 是 否 String API文档访问URI
SharePassword 是 否 String API文档分享密码
UpdatedTime 是 否 Datetime API文档更新时间
ServiceId 是 否 String 服务ID
Environment 是 否 String 环境信息
ApiIds 是 否 Array of String 生成API文档的API ID
ServiceName 是 否 String 服务名称
ApiNames 是 否 Array of String 生成API文档的API名称

ServiceEnvironmentSet

服务绑定环境详情

被如下接口引用：DescribeServiceEnvironmentList

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 服务绑定环境总数。
EnvironmentList 是 是 Array of Environment 服务绑定环境列表。

ListCloudNativeAPIGatewayResult

获取云原生API网关实例列表响应结果。

被如下接口引用：

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 总数。
GatewayList 是 否 Array of DescribeCloudNativeAPIGatewayResult 云原生API网关实例列表。

NetworkConfig

独享实例网络配置

被如下接口引用：DescribeExclusiveInstanceDetail、ModifyExclusiveInstance

名称 必选 允许NULL 类型 描述
InternetMaxBandwidthOut 是 否 Int64 最大出带宽
EnableInternetInbound 是 否 Bool EnableInternetInbound信息
EnableInternetOutbound 是 否 Bool EnableInternetOutbound信息
InboundIpAddresses 是 否 Array of String InboundIpAddresses信息
OutboundIpAddresses 是 否 Array of String OutboundIpAddresses信息

AttachedPluginInfo

已绑定的插件信息。

被如下接口引用：DescribePluginsByApi

名称 必选 允许NULL 类型 描述
PluginId 是 否 String 插件ID。
Environment 是 否 String 环境信息。
AttachedTime 是 否 String 绑定时间。
PluginName 是 否 String 插件名称。
PluginType 是 否 String 插件类型。
Description 是 否 String 插件描述。
PluginData 是 否 String 插件定义语句。

DeleteCloudNativeAPIGatewayResult

删除云原生API网关响应结果。

被如下接口引用：

名称 必选 允许NULL 类型 描述
GatewayId 是 否 String 云原生网关ID。
Status 是 否 String 云原生网关状态。

Filter

>描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等 > * 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 > * 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。 >

被如下接口引用：DescribeAPIDocs、DescribeAllPluginApis、DescribeApiAppBindApisStatus、DescribeApiAppsStatus、DescribeApiBindApiAppsStatus、DescribeApiKeysStatus、DescribeApisStatus、DescribeAvailablePluginApis、DescribeEIAMApis、DescribeExclusiveInstances、DescribeIPStrategy、DescribeIPStrategyApisStatus、DescribeIPStrategysStatus、DescribeLogSearch、DescribePlugin、DescribePluginApis、DescribePlugins、DescribePluginsByApi、DescribeServicesStatus、DescribeUpstreamBindApis、DescribeUpstreams、DescribeUsagePlansStatus

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

UpstreamNode

VPC通道后端节点元数据

被如下接口引用：CreateUpstream、DescribeUpstreams、ModifyUpstream

名称 必选 允许NULL 类型 描述
VmInstanceId 否 是 String vm实例id
Host 是 否 String IP（domain）
Port 是 否 Uint64 端口[0, 65535]
Weight 是 否 Uint64 权重[0, 100], 0为禁用
Tags 否 是 Array of String 染色标签

ServiceConfig

ServiceConfig配置

被如下接口引用：CreateApi、DescribeApi、DescribeApiForApiApp、ModifyApi

名称 必选 允许NULL 类型 描述
Product 否 否 String 后端类型。启用vpc时生效，目前支持的类型为clb和vpc通道
UniqVpcId 否 否 String vpc 的唯一ID。
Url 否 否 String API 的后端服务url。如果ServiceType是HTTP，则此参数必传。
Path 否 否 String API 的后端服务路径，如 /path。如果 ServiceType 是 HTTP，则此参数必传。前后端路径可不同。
Method 否 否 String API的后端服务请求方法，如 GET。如果 ServiceType 是 HTTP，则此参数必传。前后端方法可不同。
UpstreamId 否 是 String 当绑定vpc通道才需要

IPStrategyApi

策略绑定api列表

被如下接口引用：DescribeIPStrategyApisStatus

名称 必选 允许NULL 类型 描述
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 已经绑定的环境。

CreateApiRsp

创建api返回

被如下接口引用：CreateApi、ImportOpenApi

名称 必选 允许NULL 类型 描述
ApiId 是 是 String api id
Path 是 是 String path
Method 是 是 String method
CreatedTime 是 是 Datetime_iso 创建时间

UsagePlanBindEnvironment

使用计划绑定环境信息

被如下接口引用：CreateUsagePlan、DescribeUsagePlan、ModifyUsagePlan

名称 必选 允许NULL 类型 描述
EnvironmentName 是 是 String 环境名。
ServiceId 是 是 String 服务唯一ID。

ApiInfo

展示api信息

被如下接口引用：DescribeApi、DescribeApiForApiApp

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

RunApiReturn

调试api返回

被如下接口引用：RunApi

名称 必选 允许NULL 类型 描述
ReturnHeader 是 否 String API 接口的响应头部。
ReturnBody 是 否 String API 接口的响应包体。
ReturnCode 是 否 Int64 API 接口的响应码。
Delay 是 否 Int64 API 接口的响应延迟，单位 ms。

ApiKeyFilter

密钥过滤条件

被如下接口引用：

名称 必选 允许NULL 类型 描述
AccessKeyId 否 否 String 密钥id
AccessKeySecret 否 否 String 密钥key
NotUsagePlanId 否 否 String 未绑定的使用计划
Status 否 否 Int64 密钥状态
SecretName 否 否 String 密钥名称

ServiceEnvironmentStrategyStatus

环境绑定策略列表

被如下接口引用：DescribeServiceEnvironmentStrategy

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 限流策略数量。
EnvironmentList 是 是 Array of ServiceEnvironmentStrategy 限流策略列表。

TargetServicesReq

tsf serverless入参

被如下接口引用：CreateApi

名称 必选 允许NULL 类型 描述
DockerIp 否 否 String docker ip
VmIp 是 否 String vm ip
VpcId 是 否 String vpc id
VmPort 是 否 Int64 vm port
HostIp 是 否 String cvm所在宿主机ip

EnvironmentStrategy

环境限流

被如下接口引用：DescribeApiEnvironmentStrategy

名称 必选 允许NULL 类型 描述
EnvironmentName 是 否 String 环境名
Quota 是 否 Int64 限流值
MaxQuota 是 是 Int64 限流最大值

RequestParameter

请求参数

被如下接口引用：CreateApi

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

ApiErrorRate

api的错误率

被如下接口引用：MonitorTops

名称 必选 允许NULL 类型 描述
ApiId 是 否 String 用户可读的api id
Path 是 否 String api路径
ErrorRate 是 否 Float api 错误率
ServiceId 是 否 String 用户可读的服务id
ApiType 是 否 String api类型

UsagePlanBindSecretStatus

使用计划绑定密钥列表

被如下接口引用：DescribeUsagePlanSecretIds

名称 必选 允许NULL 类型 描述
TotalCount 是 是 Int64 使用计划绑定密钥的数量。
AccessKeyList 是 是 Array of UsagePlanBindSecret 密钥详情列表。

ResponseErrorCodeReq

错误码入参

被如下接口引用：CreateApi、ModifyApi

名称 必选 允许NULL 类型 描述
Code 否 否 Int64 自定义响应配置错误码。
Msg 否 否 String 自定义响应配置错误信息。
Desc 否 否 String 自定义响应配置错误码备注。
ConvertedCode 否 否 Int64 自定义错误码转换。
NeedConvert 否 否 Bool 是否需要开启错误码转换。

ErrorCodes

用户自定义错误码

被如下接口引用：DescribeApi、DescribeApiForApiApp

名称 必选 允许NULL 类型 描述
Code 否 是 Int64 自定义响应配置错误码。
Msg 否 是 String 自定义响应配置错误信息。
Desc 否 是 String 自定义响应配置错误码备注。
ConvertedCode 否 是 Int64 自定义错误码转换。
NeedConvert 否 是 Bool 是否需要开启错误码转换。

ApiAppApiInfos

应用信息集

被如下接口引用：DescribeApiAppBindApisStatus、DescribeApiBindApiAppsStatus

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Int64 数量
ApiAppApiSet 是 是 Array of ApiAppApiInfo 应用绑定的Api信息数组

Plugin

API网关插件详情。

被如下接口引用：CreatePlugin、DescribePlugin、DescribePlugins

名称 必选 允许NULL 类型 描述
PluginId 是 否 String 插件ID。
PluginName 是 否 String 插件名称。
PluginType 是 否 String 插件类型。
PluginData 是 否 String 插件定义语句。
Description 是 是 String 插件描述。
CreatedTime 是 否 Datetime_iso 插件创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
ModifiedTime 是 否 Datetime_iso 插件修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。
AttachedApiTotalCount 是 是 Int64 插件绑定的API总数。
AttachedApis 是 是 Array of AttachedApiInfo 插件绑定的API信息。
Tags 是 是 Array of Tag 标签
ProjectId 是 是 String 项目ID