数据结构

AccurateQpsThreshold

云原生网关限流插件参数限流的精确Qps阈值

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Unit	String	是	qps阈值控制维度,包含:second、minute、hour、day、month、year 示例值：second、minute、hour、day、month、year
GlobalConfigId	String	是	全局配置ID 示例值：aa2090e1-0117-404f-b73f-69b662b6834f

ApolloEnvParam

Apollo 环境配置参数

被如下接口引用：CreateEngine。

名称	类型	必选	描述
Name	String	是	环境名称 示例值：prod
EngineResourceSpec	String	是	环境内引擎的节点规格 ID -1C2G -2C4G 兼容原spec-xxxxxx形式的规格ID 示例值：1C2G
EngineNodeNum	Integer	是	环境内引擎的节点数量 示例值：3
StorageCapacity	Integer	是	配置存储空间大小，以GB为单位 示例值：50
VpcId	String	是	VPC ID。在 VPC 的子网内分配一个 IP 作为 ConfigServer 的访问地址 示例值：vpc-xxxxxx
SubnetId	String	是	子网 ID。在 VPC 的子网内分配一个 IP 作为 ConfigServer 的访问地址 示例值：subnet-xxxxxx
EnvDesc	String	否	环境描述 示例值：envDesc

AutoScalerBehavior

指标伸缩行为

被如下接口引用：CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy。

名称	类型	必选	描述
ScaleUp	AutoScalerRules	否	扩容行为配置
ScaleDown	AutoScalerRules	否	缩容行为配置

AutoScalerPolicy

扩容策略

被如下接口引用：CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy。

名称	类型	必选	描述
Type	String	否	类型，Pods 示例值：Pods
Value	Integer	否	数量 示例值：1
PeriodSeconds	Integer	否	扩容周期 示例值：10

AutoScalerRules

指标伸缩的规则

被如下接口引用：CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy。

名称	类型	必选	描述
StabilizationWindowSeconds	Integer	否	稳定窗口时间，扩容时默认0，缩容时默认300 示例值：300
SelectPolicy	String	否	选择策略依据 示例值：Max
Policies	Array of AutoScalerPolicy	否	扩缩容策略

BoundK8SInfo

服务治理引擎绑定的kubernetes信息

被如下接口引用：DescribeSREInstances。

名称	类型	必选	描述
BoundClusterId	String	是	绑定的kubernetes集群ID 示例值：cls-xxxxxx
BoundClusterType	String	是	绑定的kubernetes的集群类型，分tke和eks两种 示例值：eks
SyncMode	String	否	服务同步模式，all为全量同步，demand为按需同步 示例值：demand
BindRegion	String	否	绑定的kubernetes集群所在地域 示例值：ap-beijing

CLBMultiRegion

CLB多可用区信息

被如下接口引用：DescribeSREInstanceAccessAddress。

名称	类型	描述
CLBMultiZoneFlag	Boolean	是否启用多可用区 示例值：true
CLBMasterZone	String	主可用区信息 示例值：ap-guangzhou-1
CLBSlaveZone	String	备可用区信息 示例值：ap-guangzhou-2

CanaryPriorityRule

灰度规则 Priority - Rule

被如下接口引用：ModifyCloudNativeAPIGatewayCanaryRule。

名称	类型	必选	描述
Priority	Integer	否	优先级 示例值：10
CanaryRule	CloudNativeAPIGatewayCanaryRule	否	灰度规则配置

CertificateInfo

证书信息

被如下接口引用：CreateCloudNativeAPIGatewayCertificate。

名称	类型	描述
Id	String	唯一id 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201

CloudAPIGatewayCanaryRuleList

灰度规则列表

被如下接口引用：DescribeCloudNativeAPIGatewayCanaryRules。

名称	类型	描述
CanaryRuleList	Array of CloudNativeAPIGatewayCanaryRule	灰度规则
TotalCount	Integer	总数 示例值：100

CloudNativeAPIGatewayBalancedService

含百分比流量配置的服务

被如下接口引用：CreateCloudNativeAPIGatewayCanaryRule, ModifyCloudNativeAPIGatewayCanaryRule。

名称	类型	必选	描述
ServiceID	String	否	服务 ID，作为入参时，必填 示例值：2a212560-220a-46f6-b139-3238eb8ea041
ServiceName	String	否	服务名称，作为入参时，无意义 示例值：learn
UpstreamName	String	否	Upstream 名称，作为入参时，无意义 示例值：learn
Percent	Float	否	百分比，10 即 10%，范围0-100 示例值：10

CloudNativeAPIGatewayCanaryRule

灰度规则

被如下接口引用：CreateCloudNativeAPIGatewayCanaryRule, DescribeCloudNativeAPIGatewayCanaryRules, ModifyCloudNativeAPIGatewayCanaryRule。

名称	类型	必选	描述
Priority	Integer	是	优先级，值范围为 0 到 100；值越大，优先级越高；不同规则间优先级不可重复 示例值：100
Enabled	Boolean	是	是否启用规则 示例值：true
ConditionList	Array of CloudNativeAPIGatewayCanaryRuleCondition	否	参数匹配条件
BalancedServiceList	Array of CloudNativeAPIGatewayBalancedService	否	服务的流量百分比配置 注意：此字段可能返回 null，表示取不到有效值。
ServiceId	String	否	归属服务 ID 示例值：2a212560-220a-46f6-b139-3238eb8ea041
ServiceName	String	否	归属服务名称 示例值：learn-svc
RuleType	String	否	灰度规则类别 Standard｜Lane 示例值：Standard
MatchType	String	否	全链路灰度策略多个条件之间的匹配方式，与AND，或OR 示例值：AND
GroupId	String	否	泳道组ID 示例值：group-4se0czf7
GroupName	String	否	泳道组名称 示例值：公网入口分组
LaneId	String	否	泳道ID 示例值：4e00e834cc984314a9a33fa4bb08bc5a
LaneName	String	否	泳道名称 示例值：在线学习服务泳道
MatchMode	String	否	泳道匹配规则：严格STRICT｜宽松PERMISSIVE 示例值：STRICT
LaneTag	String	否	泳道标签 示例值：lane:v1

CloudNativeAPIGatewayCanaryRuleCondition

灰度规则中的条件配置

被如下接口引用：CreateCloudNativeAPIGatewayCanaryRule, ModifyCloudNativeAPIGatewayCanaryRule。

名称	类型	必选	描述
Type	String	是	条件类型，支持 path, method, query, header, cookie, body 和 system。 示例值：header
Key	String	否	参数名 示例值：x-user-id
Operator	String	否	操作符，支持 "le", "eq", "lt", "ne", "ge", "gt", "regex", "exists", "in", "not in", "prefix" ,"exact", "regex" 等 示例值：==
Value	String	否	目标参数值 示例值：user-stu
Delimiter	String	否	分隔符，当 Operator 为 in 或者 not in 时生效。支持值为英文逗号，英文分号，空格，换行符。 示例值：,
GlobalConfigId	String	否	全局配置 Id 示例值：4fe634e9-ea28-4f1e-8461-da89f3b84d28
GlobalConfigName	String	否	全局配置名称 示例值：global-conf-stu

CloudNativeAPIGatewayConfig

云原生API网关配置信息。

被如下接口引用：DescribeCloudNativeAPIGatewayConfig, DescribePublicNetwork。

名称	类型	描述
ConsoleType	String	控制台类型。 示例值：Kong
HttpUrl	String	HTTP链接地址。 示例值：http://127.0.0.1:8000/
HttpsUrl	String	HTTPS链接地址。 示例值：https://127.0.0.1:8443/
NetType	String	网络类型, Open|Internal。 示例值：Open
AdminUser	String	管理员用户名。 示例值：admin
AdminPassword	String	管理员密码。 示例值：tse@tencent
Status	String	网络状态, Open|Closed|Updating 示例值：Open
AccessControl	NetworkAccessControl	网络访问策略 注意：此字段可能返回 null，表示取不到有效值。
SubnetId	String	内网子网 ID 示例值：subnet-xxxxxxx
VpcId	String	内网VPC ID 示例值：vpc-xxxxxxx
Description	String	负载均衡的描述 示例值：公网入口
SlaType	String	负载均衡的规格类型 示例值：clb.c4.small
SlaName	String	clb规格名称 示例值：超强型1规格
Vip	String	clb vip 示例值：152.41.25.2
InternetMaxBandwidthOut	Integer	带宽 示例值：5
MultiZoneFlag	Boolean	是否多可用区 示例值：false
MasterZoneId	String	主可用区 示例值：ap-guangzhou-1
SlaveZoneId	String	备可用区 示例值：ap-guangzhou-3
MasterZoneName	String	主可用区名称 示例值：广州一区
SlaveZoneName	String	备可用区名称 示例值：广州三区
NetworkId	String	网络 id 示例值：network-1obc76ux
IPV6FullChain	Boolean	是否为新 ipv6 CLB 示例值：false
CustomizedConfigContent	String	负载均衡个性化配置内容 示例值：send_timeout 1800s;\nproxy_read_timeout 1800s;\nproxy_send_timeout 1800s;\nclient_max_body_size 256M;

CloudNativeAPIGatewayNode

云原生API网关节点信息。

被如下接口引用：DescribeCloudNativeAPIGatewayNodes。

名称	类型	描述
NodeId	String	云原生网关节点 id 示例值：kong-0
NodeIp	String	节点 ip 示例值：172.168.2.1
ZoneId	String	Zone id 示例值：100001
Zone	String	Zone 示例值：ap-guangzhou-1
GroupId	String	分组ID 示例值：group-4se0czf7
GroupName	String	分组名 示例值：公网入口分组
Status	String	状态 示例值：Running
Weight	Integer	节点权重 示例值：10
IsDefaultWeight	Boolean	是否默认权重 示例值：true

CloudNativeAPIGatewayNodeConfig

云原生API网关节点配置。

被如下接口引用：CreateCloudNativeAPIGateway, CreateNativeGatewayServerGroup, DescribeAutoScalerResourceStrategyBindingGroups, DescribeCloudNativeAPIGateway, DescribeNativeGatewayServerGroups, UpdateCloudNativeAPIGatewaySpec。

名称	类型	必选	描述
Specification	String	是	节点配置, 1c2g|2c4g|4c8g|8c16g。 示例值：1c2g
Number	Integer	是	节点数量，2-9。 示例值：2

CloudNativeAPIGatewayRateLimitDetail

云原生网关Tse 限流插件配置

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Enabled	Boolean	否	插件启用状态 示例值：true
QpsThresholds	Array of QpsThreshold	否	qps阈值 示例值：[{Unit:"second",Max:10}]
Path	String	否	需要进行流量控制的请求路径 示例值：/demo
Header	String	否	需要进行流量控制的请求头Key 示例值：Host
LimitBy	String	否	限流依据 ip service consumer credential path header 示例值：ip
ExternalRedis	ExternalRedis	否	外部redis配置
Policy	String	否	计数器策略 local 单机 redis 默认redis external_redis 外部redis 示例值：local
RateLimitResponse	RateLimitResponse	否	响应配置，响应策略为text
RateLimitResponseUrl	String	否	请求转发地址 示例值：http://127.0.0.1/downgrade
ResponseType	String	否	响应策略 url请求转发 text 响应配置 default 直接返回 示例值：url
HideClientHeaders	Boolean	否	是否隐藏限流客户端响应头 示例值：true
LineUpTime	Integer	否	排队时间 示例值：0
IsDelay	Boolean	否	是否开启请求排队 示例值：true
BasicLimitQpsThresholds	Array of QpsThreshold	否	基础限流 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{Unit:"second",Max:10}]
LimitRules	Array of LimitRule	否	参数限流的规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Filters":[{"Key":"ip","Values":["8.8.8.8/24"]}],"LimitBy":[{"Key":"ip","Value":""},{"Key":"header","Value":"host"}],"QpsThresholds":[{"Unit":"second","Max":10000}]}]

CloudNativeAPIGatewayStrategy

网关实例策略

被如下接口引用：DescribeAutoScalerResourceStrategies, DescribeNativeGatewayServerGroups。

名称	类型	描述
StrategyId	String	策略ID 示例值：strategy-7bb4fcb0
StrategyName	String	策略名称 示例值：双十一
CreateTime	String	创建时间 示例值：2021-09-09 11:52:3
ModifyTime	String	更新时间 示例值：2021-09-09 11:52:3
Description	String	策略描述 示例值：双十一弹性伸缩策略
Config	CloudNativeAPIGatewayStrategyAutoScalerConfig	弹性伸缩配置
GatewayId	String	网关实例ID 示例值：gateway-4a34cf5f
CronConfig	CloudNativeAPIGatewayStrategyCronScalerConfig	定时伸缩配置

CloudNativeAPIGatewayStrategyAutoScalerConfig

弹性伸缩策略

被如下接口引用：CreateAutoScalerResourceStrategy, DescribeAutoScalerResourceStrategies, ModifyAutoScalerResourceStrategy。

名称	类型	必选	描述
MaxReplicas	Integer	否	最大副本数 示例值：5
Metrics	Array of CloudNativeAPIGatewayStrategyAutoScalerConfigMetric	否	指标列表 注意：此字段可能返回 null，表示取不到有效值。
Behavior	AutoScalerBehavior	否	指标伸缩行为配置 注意：此字段可能返回 null，表示取不到有效值。

CloudNativeAPIGatewayStrategyAutoScalerConfigMetric

弹性伸缩配置指标

被如下接口引用：CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy。

名称	类型	必选	描述
Type	String	否	指标类型 - Resource 示例值：Resource
ResourceName	String	否	指标资源名称 - cpu - memory 示例值：cpu
TargetType	String	否	指标目标类型，目前只支持百分比Utilization 示例值：Utilization
TargetValue	Integer	否	指标目标值 示例值：80

CloudNativeAPIGatewayStrategyBindingGroupInfo

策略绑定的网关分组信息

被如下接口引用：DescribeAutoScalerResourceStrategyBindingGroups。

名称	类型	描述
GroupId	String	网关分组ID 示例值：group-2e781178
NodeConfig	CloudNativeAPIGatewayNodeConfig	节点配置
BindTime	String	绑定时间 示例值：2021-09-09 11:52:30
GroupName	String	网关分组名称 示例值：公网入口
Status	String	绑定状态 示例值：bound

CloudNativeAPIGatewayStrategyCronScalerConfig

定时伸缩策略配置

被如下接口引用：CreateAutoScalerResourceStrategy, DescribeAutoScalerResourceStrategies, ModifyAutoScalerResourceStrategy。

名称	类型	必选	描述
Params	Array of CloudNativeAPIGatewayStrategyCronScalerConfigParam	否	定时伸缩配置参数列表 注意：此字段可能返回 null，表示取不到有效值。

CloudNativeAPIGatewayStrategyCronScalerConfigParam

定时伸缩配置参数

被如下接口引用：CreateAutoScalerResourceStrategy, ModifyAutoScalerResourceStrategy。

名称	类型	必选	描述
Period	String	否	定时伸缩周期 示例值：1 * *
StartAt	String	否	定时伸缩开始时间 示例值：17:00
TargetReplicas	Integer	否	定时伸缩目标节点数，不超过指标伸缩中定义的最大节点数 示例值：50
Crontab	String	否	定时伸缩cron表达式，无需输入 示例值：0 00 00 * * *

CloudNativeAPIGatewayVpcConfig

云原生API网关vpc配置。

被如下接口引用：CreateCloudNativeAPIGateway, DescribeCloudNativeAPIGateway。

名称	类型	必选	描述
VpcId	String	否	私有网络ID。 示例值：vpc-xxxxxx
SubnetId	String	否	子网ID。 示例值：subnet-xxxxxx

ConfigFile

配置文件

被如下接口引用：CreateConfigFile, DescribeConfigFile, DescribeConfigFiles, DescribeConfigFilesByGroup, ModifyConfigFiles。

名称	类型	必选	描述
Id	Integer	否	配置文件id 示例值：configId
Name	String	否	配置文件名称 示例值：application
Namespace	String	否	配置文件命名空间 示例值：namespaceName
Group	String	否	配置文件组 示例值：groupName
Content	String	否	配置文件内容 示例值：configContent
Format	String	否	配置文件格式 示例值：text
Comment	String	否	配置文件注释 示例值：Comment
Status	String	否	配置文件状态 示例值：status
Tags	Array of ConfigFileTag	否	配置文件标签数组 示例值：["taga","tagb"]
CreateTime	String	否	配置文件创建时间 示例值：2024-12-29 16:23:00
CreateBy	String	否	配置文件创建者 示例值：usera
ModifyTime	String	否	配置文件修改时间 示例值：2024-12-29 16:23:00
ModifyBy	String	否	配置文件修改者 示例值：usera
ReleaseTime	String	否	配置文件发布时间 示例值：2024-12-29 16:23:00
ReleaseBy	String	否	配置文件发布者 示例值：usera
ConfigFileSupportedClient	Integer	否	配置文件类型 示例值：client_sdk
ConfigFilePersistent	ConfigFilePersistent	否	配置文件持久化
Encrypted	Boolean	否	是否开启加密算法 示例值：true
EncryptAlgo	String	否	加密算法 示例值：AES

ConfigFileGroup

配置文件组

被如下接口引用：CreateConfigFileGroup, DescribeConfigFileGroups, ModifyConfigFileGroup。

名称	类型	必选	描述
Id	Integer	否	配置文件组id 示例值：100
Name	String	否	配置文件组名称 示例值：janice-test
Namespace	String	否	命名空间 示例值：namespaceName
Comment	String	否	备注 示例值：Comment
CreateTime	String	否	创建时间 示例值：2023-03-07 00:00:00
CreateBy	String	否	创建者 示例值：usera
ModifyTime	String	否	修改时间 示例值：2023-03-07 00:00:00
ModifyBy	String	否	修改者 示例值：userb
FileCount	Integer	否	文件数 示例值：100
UserIds	Array of String	否	关联用户，link_users 示例值：["usera","userb"]
GroupIds	Array of String	否	组id，link_groups 示例值：["group-1"]
RemoveUserIds	Array of String	否	remove_link_users 示例值：["usera"]
RemoveGroupIds	Array of String	否	remove_link_groups 示例值：["group-1"]
Editable	Boolean	否	是否可编辑 示例值：true
Owner	String	否	归属者 示例值：usera
Department	String	否	部门 示例值：DepartmentName
Business	String	否	业务 示例值：BusinessName
ConfigFileGroupTags	Array of ConfigFileGroupTag	否	配置文件组标签 示例值：["taga"]

ConfigFileGroupTag

配置文件标签

被如下接口引用：CreateConfigFileGroup, DescribeConfigFileGroups, ModifyConfigFileGroup。

名称	类型	必选	描述
Key	String	否	key-value 键 示例值：Name
Value	String	否	key-value 值 示例值：Tom

ConfigFilePersistent

配置文件持久化

被如下接口引用：CreateConfigFile, DescribeConfigFile, DescribeConfigFileRelease, DescribeConfigFileReleaseHistories, DescribeConfigFileReleases, DescribeConfigFiles, DescribeConfigFilesByGroup, ModifyConfigFiles, PublishConfigFiles, RollbackConfigFileReleases。

名称	类型	必选	描述
Encoding	String	否	文件编码 示例值：UTF-8
Path	String	否	文件下发路径 示例值：/path/var
PostCmd	String	否	文件后置命令 示例值：echo aaa;\n echo ccc

ConfigFilePublishInfo

发布详情

被如下接口引用：CreateOrUpdateConfigFileAndRelease。

名称	类型	必选	描述
ReleaseName	String	否	发布名称 示例值：v1
Namespace	String	否	命名空间 示例值：namespaceName
Group	String	否	发布组 示例值：privoder-demo
FileName	String	否	文件名 示例值：application.yml
Content	String	否	内容 示例值：hello
Comment	String	否	描述 示例值：comment
Format	String	否	格式 示例值：yaml
CreateBy	String	否	创建者 示例值：usera
ModifyBy	String	否	修改者 示例值：usera
Tags	Array of ConfigFileTag	否	标签

ConfigFileRelease

配置文件发布

被如下接口引用：DescribeConfigFileRelease, DescribeConfigFileReleases, PublishConfigFiles, RollbackConfigFileReleases。

名称	类型	必选	描述
Id	Integer	否	配置文件发布id 示例值：1
Name	String	否	配置文件发布名称 示例值：application
Namespace	String	否	配置文件发布命名空间 示例值：namespaceName
Group	String	否	配置文件发布组 示例值：provider-demo
FileName	String	否	配置文件发布文件名称 示例值：application.yml
Content	String	否	配置文件发布内容 示例值：hello
Comment	String	否	配置文件发布注释 示例值：comment
Md5	String	否	配置文件发布Md5 示例值：md5hash
Version	Integer	否	配置文件发布版本 示例值：1
CreateTime	String	否	配置文件发布创建时间 示例值：2024-12-29 16:23:00
CreateBy	String	否	配置文件发布创建者 示例值：usera
ModifyTime	String	否	配置文件发布修改时间 示例值：2024-12-29 16:23:00
ModifyBy	String	否	配置文件发布修改者 示例值：usera
ReleaseDescription	String	否	发布描述 示例值：config-desc
Active	Boolean	否	是否生效 示例值：true
Format	String	否	格式 示例值：yaml
ConfigFileId	String	否	配置文件ID 示例值：name
ConfigFileSupportedClient	Integer	否	配置文件类型 示例值：client_sdk
ConfigFilePersistent	ConfigFilePersistent	否	配置文件持久化

ConfigFileReleaseDeletion

配置发布删除

被如下接口引用：DeleteConfigFileReleases。

名称	类型	必选	描述
Namespace	String	否	命名空间 示例值：namespaceName
Group	String	否	配置分组 示例值：provider-demo
FileName	String	否	文件名称 示例值：application,yml
ReleaseVersion	String	否	发布版本 示例值：v1.0
Id	Integer	否	配置发布ID 示例值：1

ConfigFileReleaseHistory

配置文件发布历史

被如下接口引用：DescribeConfigFileReleaseHistories。

名称	类型	描述
Id	Integer	配置文件发布历史记录id 示例值：1
Name	String	配置文件发布历史名称 示例值：configName
Namespace	String	配置文件发布历史命名空间 示例值：namespaceName
Group	String	配置文件发布历史组 示例值：provider-demo
FileName	String	配置文件发布历史名称 示例值：application,yml
Content	String	配置文件发布历史内容 示例值：hello
Format	String	配置文件发布历史格式 示例值：yaml
Comment	String	配置文件发布历史注释 示例值：comment
Md5	String	配置文件发布历史Md5 示例值：md5hash
Type	String	配置文件发布历史类型 示例值：config
Status	String	配置文件发布历史状态 示例值：status
Tags	Array of ConfigFileTag	配置文件发布历史标签组
CreateTime	String	配置文件发布创建时间 示例值：2024-12-29 16:23:00
CreateBy	String	配置文件发布创建者 示例值：usera
ModifyTime	String	配置文件发布修改时间 示例值：2024-12-29 16:23:00
ModifyBy	String	配置文件发布修改者 示例值：usera
ReleaseDescription	String	发布描述 示例值：desc
ReleaseReason	String	原因，用于失败时原因展示 示例值：publish error
ConfigFileSupportedClient	Integer	配置文件类型 示例值：client_sdk
ConfigFilePersistent	ConfigFilePersistent	配置文件持久化

ConfigFileTag

配置文件标签

被如下接口引用：CreateConfigFile, CreateOrUpdateConfigFileAndRelease, DescribeConfigFile, DescribeConfigFileReleaseHistories, DescribeConfigFiles, DescribeConfigFilesByGroup, ModifyConfigFiles。

名称	类型	必选	描述
Key	String	否	key-value 键 示例值：name
Value	String	否	key-value 值 示例值：tom

ConfigFileTemplate

配置文件模板

被如下接口引用：DescribeAllConfigFileTemplates。

名称	类型	描述
Id	Integer	配置文件模板id 示例值：template-id
Name	String	配置文件模板名称 示例值：name
Content	String	配置文件模板内容 示例值：content
Format	String	配置文件模板格式 示例值：yaml
Comment	String	配置文件模板注释 示例值：comment
CreateTime	String	配置文件模板创建时间 示例值：2024-10-08 10:00:00
CreateBy	String	配置文件模板创建者 示例值：user
ModifyTime	String	配置文件模板修改时间 示例值：2024-10-08 10:00:00
ModifyBy	String	配置文件模板修改者 示例值：user

CreateCloudNativeAPIGatewayResult

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

被如下接口引用：CreateCloudNativeAPIGateway。

名称	类型	描述
GatewayId	String	云原生API网关ID。 示例值：gateway-xxxxxx
Status	String	云原生网关状态。 示例值：Creating
TaskId	String	任务ID 示例值：task-xxx

CreateCloudNativeAPIGatewayServerGroupResult

创建网关分组信息

被如下接口引用：CreateNativeGatewayServerGroup。

名称	类型	描述
GatewayId	String	网关实例id 示例值：gateway-xxxx1234
GroupId	String	分组id 示例值：group-xxxx1234
Status	String	状态 示例值：Running
TaskId	String	任务ID 示例值：task-xxxx1234

CreateGatewayServiceResult

创建云原生网关服务结果

被如下接口引用：CreateCloudNativeAPIGatewayService。

名称	类型	描述
ServiceId	String	网关服务ID 示例值：2a212560-220a-46f6-b139-3238eb8ea041

CreatePublicNetworkResult

创建kong客户端公网结果

被如下接口引用：CreateCloudNativeAPIGatewayPublicNetwork。

名称	类型	描述
GatewayId	String	网关实例ID 示例值：gateway-xxxxxxxx
GroupId	String	分组ID 示例值：group-xxxxxxxx
NetworkId	String	客户端公网网络ID 示例值：network-xxxxxxxx

DeleteCloudNativeAPIGatewayResult

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

被如下接口引用：DeleteCloudNativeAPIGateway。

名称	类型	描述
GatewayId	String	云原生网关ID。 示例值：gateway-xxxxxx
Status	String	云原生网关状态。 示例值：Deleting

DeleteNativeGatewayServerGroupResult

删除网关实例结果

被如下接口引用：DeleteNativeGatewayServerGroup。

名称	类型	描述
GatewayId	String	网关实例id 示例值：gateway-xxxx1234
GroupId	String	网关分组id 示例值：group-xxxx1235
Status	String	删除状态 示例值：Deleting
TaskId	String	任务ID 示例值：task-xxxx1236

DescribeCloudNativeAPIGatewayConfigResult

获取云原生API网关实例网络配置结果。

被如下接口引用：DescribeCloudNativeAPIGatewayConfig。

名称	类型	描述
GatewayId	String	网关实例ID。 示例值：gateway-xxxxxx
ConfigList	Array of CloudNativeAPIGatewayConfig	分组网络配置列表。
GroupSubnetId	String	分组子网信息 示例值：subnet-xxxxx
GroupVpcId	String	分组VPC信息 示例值：vpc-xxxxx
GroupId	String	分组ID 示例值：group-xxx

DescribeCloudNativeAPIGatewayNodesResult

获取网关节点信息

被如下接口引用：DescribeCloudNativeAPIGatewayNodes。

名称	类型	描述
TotalCount	Integer	获取云原生API网关节点列表响应结果。 示例值：1
NodeList	Array of CloudNativeAPIGatewayNode	云原生API网关节点列表。

DescribeCloudNativeAPIGatewayResult

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

被如下接口引用：DescribeCloudNativeAPIGateway, DescribeCloudNativeAPIGateways。

名称	类型	描述
GatewayId	String	云原生API网关ID。 示例值：gateway-xxxxxx
Status	String	云原生API网关状态。 示例值：Running
Name	String	云原生API网关名。 示例值：kong-test
Type	String	云原生API网关类型。 示例值：Kong
GatewayVersion	String	实例版本： - 2.4.1 - 2.5.1 示例值：2.4.1
NodeConfig	CloudNativeAPIGatewayNodeConfig	云原生API网关节点信息。
VpcConfig	CloudNativeAPIGatewayVpcConfig	云原生API网关vpc配置。
Description	String	云原生API网关描述。 示例值：test kong
CreateTime	String	云原生API网关创建时间。 示例值：2021-09-09 11:52:30
Tags	Array of InstanceTagInfo	实例的标签信息
EnableCls	Boolean	是否开启 cls 日志 示例值：true
TradeType	Integer	付费模式，0表示后付费，1预付费 示例值：0
FeatureVersion	String	实例版本，当前支持开发版、标准版、专业版【TRIAL、STANDARD、PROFESSIONAL】 示例值：STANDARD
InternetMaxBandwidthOut	Integer	公网出流量带宽，[1,2048]Mbps 示例值：10
AutoRenewFlag	Integer	自动续费标记，0表示默认状态(用户未设置，即初始状态)； 1表示自动续费，2表示明确不自动续费(用户设置)，若业务无续费概念或无需自动续费，需要设置为0 示例值：0
CurDeadline	String	到期时间，预付费时使用 示例值：2021-09-09 11:52:30
IsolateTime	String	隔离时间，实例隔离时使用 示例值：2021-09-09 11:52:30
EnableInternet	Boolean	是否开启客户端公网。 示例值：true
EngineRegion	String	实例实际的地域信息 示例值：ap-guangzhou
IngressClassName	String	Ingress class名称 示例值：nginx
InternetPayMode	String	公网计费方式。可选取值 BANDWIDTH | TRAFFIC ，表示按带宽和按流量计费。 示例值：TRAFFIC
GatewayMinorVersion	String	云原生API网关小版本号 示例值：2.4.1.0
InstancePort	InstancePort	实例监听的端口信息
LoadBalancerType	String	公网CLB默认类型 示例值：L7
PublicIpAddresses	Array of String	公网IP地址列表 示例值：["145.215.23.2"]
DeleteProtect	Boolean	是否开启删除保护 示例值：false
AvailableVersions	Array of String	表示可以升级的版本号 注意：此字段可能返回 null，表示取不到有效值。 示例值：["2.5.1","2.8.5"]

DescribeGatewayInstancePortResult

获取云原生API网关实例协议端口列表响应结果

被如下接口引用：DescribeCloudNativeAPIGatewayPorts。

名称	类型	描述
GatewayId	String	云原生API网关ID 示例值：gateway-xxxxxx
GatewayInstancePortList	Array of GatewayInstanceSchemeAndPorts	网关实例协议端口列表

DescribeInstanceInfoByIpResult

根据公网IP查询云原生网关实例信息出参

被如下接口引用：DescribeCloudNativeAPIGatewayInfoByIp。

名称	类型	描述
GatewayId	String	实例id 示例值：gateway-xxx
GroupId	String	分组id 示例值：group-xxx

DescribeInstanceRegionInfo

实例地域信息描述

被如下接口引用：DescribeSREInstances。

名称	类型	描述
EngineRegion	String	引擎部署地域信息 示例值：ap-guangzhou
Replica	Integer	引擎在该地域的副本数 示例值：1
SpecId	String	引擎在该地域的规格id 示例值：spec-xxx
IntranetVpcInfos	Array of VpcInfo	客户端内网的网络信息
ConsoleIntranetVpcInfos	Array of VpcInfo	控制台内网的网络信息
EnableClientInternet	Boolean	是否开公网 示例值：true
LimiterIntranetVpcInfos	Array of VpcInfo	限流客户端内网的网络信息
MainRegion	Boolean	是否为主地域，仅在服务治理中心多地域有效 示例值：true
EKSClusterID	String	该地域所在的EKS集群 示例值：cluster-id

DescribeKongIpRestrictionResult

查询云原生网关访问控制配置出参

被如下接口引用：DescribeCloudNativeAPIGatewayIPRestriction。

名称	类型	描述
SourceType	String	访问控制插件绑定的资源类型：route | service 注意：此字段可能返回 null，表示取不到有效值。 示例值：route
SourceId	String	路由或服务的id 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx
Enabled	Boolean	是否启用插件 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
RestrictionType	String	访问控制类型：whiteList｜blackList 注意：此字段可能返回 null，表示取不到有效值。 示例值：whiteList
AddressList	Array of String	cidr｜ip 注意：此字段可能返回 null，表示取不到有效值。 示例值：[1.1.1.1,2.2.2.2]

DescribePublicAddressConfigResult

获取云原生api网关公网地址信息响应结果

被如下接口引用：DescribePublicAddressConfig。

名称	类型	描述
GatewayId	String	网关实例id 示例值：gateway-xxx1234
ConfigList	Array of PublicAddressConfig	公网地址信息
TotalCount	Integer	总个数 示例值：10

DescribePublicNetworkResult

查询客户端公网信息

被如下接口引用：DescribePublicNetwork。

名称	类型	描述
GatewayId	String	网关实例ID 示例值：gateway-xxxxxxxx
GroupId	String	网关分组ID 示例值：group-xxxxxx
PublicNetwork	CloudNativeAPIGatewayConfig	客户端公网信息

DescribeWafDomainsResult

获取WAF保护域名列表

被如下接口引用：DescribeWafDomains。

名称	类型	描述
Domains	Array of String	WAF防护域名列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：tencent.com

DescribeWafProtectionResult

获取WAF保护资源状态

被如下接口引用：DescribeWafProtection。

名称	类型	描述
GlobalStatus	String	全局防护状态 示例值：Open
ServicesStatus	Array of ServiceWafStatus	服务防护状态
RouteStatus	Array of RouteWafStatus	路由防护状态
ObjectStatus	String	对象防护状态 示例值：Open

EngineAdmin

引擎的初始管理账号，当前仅支持Apollo引擎

被如下接口引用：CreateEngine。

名称	类型	必选	描述
Name	String	否	控制台初始用户名 示例值：nacos
Password	String	否	控制台初始密码 示例值：password
Token	String	否	引擎接口的管理员 Token 示例值：token

EngineRegionInfo

引擎地域配置详情

被如下接口引用：CreateEngine。

名称	类型	必选	描述
EngineRegion	String	是	引擎节点所在地域 示例值：ap-guangzhou
Replica	Integer	是	此地域节点分配数量 示例值：2
VpcInfos	Array of VpcInfo	是	集群网络信息 示例值：[{"VpcId":"vpc-XXX","SubnetId":"subnet-XXX"}]
MainRegion	Boolean	否	Polaris: 是否为主地域 Zookeeper: 是否为Leader固定地域 示例值：true
SpecId	String	否	引擎规格ID 示例值：SPEC_1C2G

EnvAddressInfo

多环境网络信息

被如下接口引用：DescribeSREInstanceAccessAddress。

名称	类型	描述
EnvName	String	环境名 示例值：dev
EnableConfigInternet	Boolean	是否开启config公网 示例值：true
ConfigInternetServiceIp	String	config公网ip 示例值：10.0.0.1
ConfigIntranetAddress	String	config内网访问地址 示例值：10.0.0.1:8080
EnableConfigIntranet	Boolean	是否开启config内网clb 示例值：true
InternetBandWidth	Integer	客户端公网带宽 示例值：1
CLBMultiRegion	CLBMultiRegion	客户端公网CLB多可用区信息

EnvInfo

环境具体信息

被如下接口引用：DescribeSREInstances。

名称	类型	必选	描述
EnvName	String	是	环境名称 示例值：pro
VpcInfos	Array of VpcInfo	是	环境对应的网络信息 示例值：[{"VpcId":"vpc-xxxxxxx","SubnetId":"subnet-xxxxxxxx"}]
StorageCapacity	Integer	是	云硬盘容量 示例值：50
Status	String	否	运行状态 示例值：running
AdminServiceIp	String	否	Admin service 访问地址 示例值：xxxx.xx.xx.xx
ConfigServiceIp	String	否	Config service访问地址 示例值：xxxx.xx.xx.xx
EnableConfigInternet	Boolean	否	是否开启config-server公网 示例值：false
ConfigInternetServiceIp	String	否	config-server公网访问地址 示例值：xx.xx.xx.xx
SpecId	String	否	规格ID 示例值：spec-xx
EnvReplica	Integer	否	环境的节点数 示例值：3
RunningCount	Integer	否	环境运行的节点数 示例值：3
AliasEnvName	String	否	环境别名 示例值：pro
EnvDesc	String	否	环境描述 示例值：envDesc
ClientBandWidth	Integer	否	客户端带宽 示例值：5
EnableConfigIntranet	Boolean	否	客户端内网开关 示例值：true

ExternalRedis

云原生网关限流插件外部redis配置

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
RedisHost	String	是	redis ip 示例值：127.0.0.1
RedisPassword	String	是	redis密码 示例值：password
RedisPort	Integer	是	redis端口 示例值：80
RedisTimeout	Integer	是	超时时间 ms 示例值：10

Filter

查询过滤通用对象

被如下接口引用：DescribeCloudNativeAPIGateways, DescribeGovernanceServices, DescribeNativeGatewayServerGroups, DescribeSREInstances。

名称	类型	必选	描述
Name	String	是	过滤参数名 示例值：filter-name
Values	Array of String	是	过滤参数值 示例值：["a","b"]

GatewayInstanceSchemeAndPorts

网关实例协议端口列表

被如下接口引用：DescribeCloudNativeAPIGatewayPorts。

名称	类型	描述
Scheme	String	端口协议，可选HTTP、HTTPS、TCP和UDP 示例值：HTTP
PortList	Array of Integer	端口列表 示例值：[80]

GatewayServices

轻量查询网关服务列表出参

被如下接口引用：DescribeCloudNativeAPIGatewayServicesLight。

名称	类型	描述
ServiceList	Array of KongServiceLightPreview	服务列表
TotalCount	Integer	结果总数 示例值：10

GovernanceAlias

服务别名结构信息

被如下接口引用：DeleteGovernanceAliases, DescribeGovernanceAliases。

名称	类型	必选	描述
Alias	String	否	服务别名 示例值：TestSvcAlias
AliasNamespace	String	否	服务别名命名空间 示例值：Production
Service	String	否	服务别名指向的服务名 示例值：TestSvc
Namespace	String	否	服务别名指向的服务命名空间 示例值：default
Comment	String	否	服务别名的描述信息 示例值：comment
CreateTime	String	否	服务别名创建时间 示例值：2021-11-12 12:14:00
ModifyTime	String	否	服务别名修改时间 示例值：2021-11-12 12:14:00
Id	String	否	服务别名ID 示例值：1
Editable	Boolean	否	该服务别名是否可以编辑 示例值：true
Metadatas	Array of Metadata	否	元数据信息 注意：此字段可能返回 null，表示取不到有效值。

GovernanceInstance

治理中心实例信息。

被如下接口引用：DescribeGovernanceInstances。

名称	类型	描述
Id	String	实例id。 示例值：5d8e809b8dd6a8a57ff2f81cab40fc57ad4e8b55d
Service	String	实例所在服务名。 示例值：Producer
Namespace	String	实例所在命名空间名。 示例值：Development
Host	String	实例ip地址。 示例值：192.168.1.1
Port	Integer	实例端口信息。 示例值：8080
Protocol	String	通信协议。 示例值：grpc
Version	String	版本信息。 示例值：v1
Weight	Integer	负载均衡权重。 示例值：100
EnableHealthCheck	Boolean	是否开启健康检查。 示例值：true
Healthy	Boolean	实例是否健康。 示例值：true
Isolate	Boolean	实例是否隔离。 示例值：true
CreateTime	String	实例创建时间。 示例值：2021-08-11 18:49:51
ModifyTime	String	实例修改时间。 示例值：2021-08-11 18:49:51
Metadatas	Array of Metadata	元数据数组。
Ttl	Integer	上报心跳间隔。 示例值：5
InstanceVersion	String	版本信息。 示例值：v1.0
HealthStatus	String	状态信息 示例值：health
Comment	String	描述 示例值：comment

GovernanceInstanceInput

实例信息

被如下接口引用：CreateGovernanceInstances。

名称	类型	必选	描述
Service	String	是	实例所在服务名。 示例值：Producer
Namespace	String	是	实例服务所在命名空间。 示例值：Development
Weight	Integer	否	实例负载均衡权重信息。不填默认为100。 示例值：100
Healthy	Boolean	否	实例默认健康信息。不填默认为健康。 示例值：true
Isolate	Boolean	否	实例隔离信息。不填默认为非隔离。 示例值：true
Host	String	否	实例ip。 示例值：192.168.1.1
Port	Integer	否	实例监听端口。 示例值：8080
Protocol	String	否	实例使用协议。不填默认为空。 示例值：grpc
InstanceVersion	String	否	实例版本。不填默认为空。 示例值：v1
EnableHealthCheck	Boolean	否	是否启用健康检查。不填默认不启用。 示例值：true
Ttl	Integer	否	上报心跳时间间隔。若 EnableHealthCheck 为不启用，则此参数不生效；若 EnableHealthCheck 启用，此参数不填，则默认 ttl 为 5s。 示例值：5

GovernanceInstanceUpdate

实例信息

被如下接口引用：DeleteGovernanceInstances, DeleteGovernanceInstancesByHost, ModifyGovernanceInstances。

名称	类型	必选	描述
Service	String	是	实例所在服务名。 示例值：Producer
Namespace	String	是	实例服务所在命名空间。 示例值：Development
Weight	Integer	否	实例负载均衡权重信息。不填默认为100。 示例值：100
Healthy	Boolean	否	实例默认健康信息。不填默认为健康。 示例值：true
Isolate	Boolean	否	实例隔离信息。不填默认为非隔离。 示例值：true
Host	String	否	实例ip。 示例值：192.168.1.1
Port	Integer	否	实例监听端口。 示例值：8080
Protocol	String	否	实例使用协议。不填默认为空。 示例值：grpc
InstanceVersion	String	否	实例版本。不填默认为空。 示例值：v1
EnableHealthCheck	Boolean	否	是否启用健康检查。不填默认不启用。 示例值：true
Ttl	Integer	否	上报心跳时间间隔。若 EnableHealthCheck 为不启用，则此参数不生效；若 EnableHealthCheck 启用，此参数不填，则默认 ttl 为 5s。 示例值：5
Id	String	否	治理中心服务实例id。 示例值：0662cc4b73fae0a4b911363f25a51e3434de0d8c343
Metadatas	Array of Metadata	否	元数据信息。

GovernanceInterfaceDescription

服务契约接口定义

被如下接口引用：DescribeGovernanceServiceContracts。

名称	类型	必选	描述
ID	String	否	契约接口ID 示例值：id
Method	String	否	方法名称 示例值：GET
Path	String	否	路径/接口名称 示例值：/path
Content	String	否	内容 示例值：content
Source	String	否	创建来源 示例值：source
Revision	String	否	信息摘要 示例值：hash
CreateTime	String	否	创建时间 示例值：2024-10-08 10:00:00
ModifyTime	String	否	修改时间 示例值：2024-10-08 10:00:00
Name	String	否	接口名称 示例值：name

GovernanceNamespace

治理中心命名空间

被如下接口引用：DescribeGovernanceNamespaces。

名称	类型	描述
Name	String	命名空间名称。 示例值：Development
Comment	String	命名空间描述信息。 示例值：开发环境
CreateTime	String	创建时间。 示例值：2021-08-11 04:07:00
ModifyTime	String	修改时间。 示例值：2021-08-11 06:09:38
TotalServiceCount	Integer	命名空间下总服务数据量 示例值：1000
TotalHealthInstanceCount	Integer	命名空间下总健康实例数量 示例值：1000
TotalInstanceCount	Integer	命名空间下总实例数量 示例值：1000
Id	String	命名空间ID 示例值：1
Editable	Boolean	是否可以编辑 示例值：true
UserIds	Array of String	可以操作此命名空间的用户ID列表 示例值：["usera"]
GroupIds	Array of String	可以操作此命名空间的用户组ID列表 示例值：["group-1"]
RemoveUserIds	Array of String	移除可以操作此命名空间的用户ID列表 示例值：["usera"]
RemoveGroupIds	Array of String	移除可以操作此命名空间的用户组ID列表 示例值：["group-1"]
ServiceExportTo	Array of String	该命名空间下的服务对哪些命名空间可见 示例值：[Namespace-1,Namespace-2]
SyncToGlobalRegistry	Boolean	是否开启同步到全局注册中心 示例值：false
Metadatas	Array of Metadata	元数据 注意：此字段可能返回 null，表示取不到有效值。

GovernanceNamespaceInput

治理中心命名空间输入参数

被如下接口引用：CreateGovernanceNamespaces, DeleteGovernanceNamespaces, ModifyGovernanceNamespaces。

名称	类型	必选	描述
Name	String	是	命名空间名。 示例值：Development
Comment	String	否	描述信息。 示例值：开发环境
UserIds	Array of String	否	新增的可以操作此命名空间的用户ID列表 示例值：[1,2,3,4]
GroupIds	Array of String	否	新增的可以操作此命名空间的用户组ID列表 示例值：[1,2,3]
RemoveUserIds	Array of String	否	移除可以操作此命名空间的用户ID列表 示例值：[1,2,3]
RemoveGroupIds	Array of String	否	移除可以操作此命名空间的用户组ID列表 示例值：[1,2,3]
ServiceExportTo	Array of String	否	该命名空间下的服务对哪些命名空间下可见， 1、为空或者不填写，表示仅当前命名空间可见 2、列表内容仅一个元素，且为字符 *，表示所有命名空间可见（包括新增） 3、列表内容为部份命名空间名称，则只对这些命名空间下可见 示例值：[Namespace-1, Namespace-2]
SyncToGlobalRegistry	Boolean	否	是否开启同步到全局注册中心 示例值：false

GovernanceService

治理中心服务信息。

被如下接口引用：DescribeGovernanceServices。

名称	类型	描述
Name	String	服务名称。 示例值：provider-demo
Namespace	String	命名空间名称。 示例值：namespaceName
Metadatas	Array of Metadata	元数据信息数组。
Comment	String	描述信息。 示例值：comment
CreateTime	String	创建时间。 示例值：2024-12-29 16:23:00
ModifyTime	String	修改时间。 示例值：2024-12-29 16:23:00
Department	String	服务所属部门。 示例值：departmentName
Business	String	服务所属业务。 示例值：businessName
HealthyInstanceCount	Integer	健康服务实例数 示例值：1
TotalInstanceCount	Integer	服务实例总数 示例值：1
Id	String	服务ID 示例值：1
Editable	Boolean	是否可以编辑 示例值：true
UserIds	Array of String	可以编辑该资源的用户ID 示例值：["usera"]
GroupIds	Array of String	可以编辑该资源的用户组ID 示例值：["group-1"]
RemoveUserIds	Array of String	移除可以编辑该资源的用户ID 示例值：["usera"]
RemoveGroupIds	Array of String	移除可以编辑该资源的用户组ID 示例值：["group-1"]
ExportTo	Array of String	该服务对哪些命名空间可见 示例值：[ "Namespace-2"]
Revision	String	该服务信息摘要签名 示例值：hash
SyncToGlobalRegistry	Boolean	是否开启同步到全局注册中心 示例值：false
IsolateInstanceCount	Integer	隔离实例数 示例值：1
ServiceStatus	Integer	服务健康状态 示例值：1

GovernanceServiceContract

服务契约定义

被如下接口引用：DescribeGovernanceServiceContracts。

名称	类型	必选	描述
Name	String	是	契约名称 示例值：name
Namespace	String	是	所属服务命名空间 示例值：namespace
Protocol	String	是	协议 示例值：tcp
ID	String	否	契约ID 示例值：id
Service	String	否	所属服务名称 示例值：service
Version	String	否	版本 示例值：1.0
Revision	String	否	信息摘要 示例值：hash
Content	String	否	额外内容描述 示例值：content
CreateTime	String	否	创建时间 示例值：2024-10-08 10:00:00
ModifyTime	String	否	修改时间 示例值：2024-10-08 10:00:00
Interfaces	Array of GovernanceInterfaceDescription	否	契约接口列表
Metadatas	Array of Metadata	否	元数据 注意：此字段可能返回 null，表示取不到有效值。

GovernanceServiceContractVersion

服务契约版本信息

被如下接口引用：DescribeGovernanceServiceContractVersions。

名称	类型	描述
Version	String	契约版本 示例值：v1
Name	String	契约名称 示例值：config
Key	String	唯一名称 示例值：config-v1

GovernanceServiceInput

治理中心服务入参

被如下接口引用：CreateGovernanceServices, DeleteGovernanceServices, ModifyGovernanceServices。

名称	类型	必选	描述
Name	String	是	服务名。 示例值：Producer
Namespace	String	是	服务所属命名空间。 示例值：Development
Comment	String	否	服务描述信息。 示例值：生产者服务。
Metadatas	Array of Metadata	否	服务元数据。
Department	String	否	服务所属部门。 示例值：市场部
Business	String	否	服务所属业务。 示例值：采购业务
UserIds	Array of String	否	被添加进来可以操作此命名空间的用户ID列表 示例值：[1,2,3]
GroupIds	Array of String	否	被添加进来可以操作此命名空间的用户组ID列表 示例值：[1,2,3]
RemoveUserIds	Array of String	否	从操作此命名空间的用户组ID列表被移除的ID列表 示例值：[1,2,3]
RemoveGroupIds	Array of String	否	从可以操作此命名空间的用户组ID列表中被移除的ID列表 示例值：[1,2,3]
ExportTo	Array of String	否	该服务对哪些命名空间可见 示例值：[Namespace-1,Namespace-2]
SyncToGlobalRegistry	Boolean	否	是否开启同步到全局注册中心 示例值：false

InstancePort

实例监听端口信息

被如下接口引用：DescribeCloudNativeAPIGateway。

名称	类型	描述
HttpPort	String	监听的 http 端口范围。 示例值：80
HttpsPort	String	监听的 https 端口范围。 示例值：443
TcpPort	String	监听的 tcp 端口范围。 示例值：8000
UdpPort	String	监听的 udp 端口范围。 示例值：7000

InstanceTagInfo

引擎实例的标签信息

被如下接口引用：CreateCloudNativeAPIGateway, CreateEngine, DescribeCloudNativeAPIGateway, DescribeInstanceTagInfos。

名称	类型	必选	描述
TagKey	String	否	标签键 示例值：key
TagValue	String	否	标签值 示例值：value

InternetConfig

公网负载均衡配置

被如下接口引用：CreateCloudNativeAPIGateway, CreateCloudNativeAPIGatewayPublicNetwork, CreateNativeGatewayServerGroup。

名称	类型	必选	描述
InternetAddressVersion	String	否	公网地址版本，可选："IPV4" | "IPV6" 。不填默认 IPV4 。 示例值：IPV6
InternetPayMode	String	否	公网付费类型，当前仅可选："BANDWIDTH"。不填默认为 "BANDWIDTH" 示例值：BANDWIDTH
InternetMaxBandwidthOut	Integer	否	公网带宽。 示例值：5
Description	String	否	负载均衡描述 示例值：公网入口
SlaType	String	否	负载均衡的规格类型，支持clb.c2.medium、clb.c3.small、clb.c3.medium、clb.c4.small、clb.c4.medium、clb.c4.large、clb.c4.xlarge，不传为共享型。 示例值：clb.c4.small
MultiZoneFlag	Boolean	否	负载均衡是否多可用区 示例值：false
MasterZoneId	String	否	主可用区 示例值：ap-guangzhou-1
SlaveZoneId	String	否	备可用区 示例值：ap-guangzhou-3

KVMapping

键值对

被如下接口引用：CreateCloudNativeAPIGatewayRoute, CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayRoutes, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRoute, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Key	String	否	key 示例值：key
Value	String	否	value 示例值：value

KVPair

键值对

被如下接口引用：DescribeSREInstances。

名称	类型	必选	描述
Key	String	否	键 示例值：type
Value	String	否	值 示例值：dev

KeyValue

Key/Value结构

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Key	String	否	条件的Key 示例值：header
Value	String	否	条件的Value 示例值：host

KongActiveHealthCheck

Kong网关主动健康检查配置

被如下接口引用：DescribeUpstreamHealthCheckConfig, UpdateUpstreamHealthCheckConfig。

名称	类型	必选	描述
HealthyInterval	Integer	否	主动健康检查健康探测间隔，单位：秒，0表示不开启 示例值：0
UnHealthyInterval	Integer	否	主动健康检查异常探测间隔，单位：秒，0表示不开启 示例值：0
HttpPath	String	否	在 GET HTTP 请求中使用的路径，以作为主动运行状况检查的探测器运行。默认： ”/”。 示例值：/v1/users
Timeout	Float	否	GET HTTP 请求的超时时间，单位：秒。默认 60。 示例值：60

KongCertificate

云原生网关证书

被如下接口引用：DescribeCloudNativeAPIGatewayCertificateDetails。

名称	类型	描述
Cert	KongCertificatesPreview	无

KongCertificatesList

kong证书列表

被如下接口引用：DescribeCloudNativeAPIGatewayCertificates。

名称	类型	描述
Total	Integer	证书列表总数 示例值：2
CertificatesList	Array of KongCertificatesPreview	无 注意：此字段可能返回 null，表示取不到有效值。

KongCertificatesPreview

云原生网关证书预览信息

被如下接口引用：DescribeCloudNativeAPIGatewayCertificateDetails, DescribeCloudNativeAPIGatewayCertificates。

名称	类型	描述
Name	String	证书名称 示例值：tencent.com
Id	String	Id 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
BindDomains	Array of String	绑定的域名 示例值：["abc.com"]
Status	String	证书状态：expired(已过期) active(生效中) 示例值：expired
Crt	String	证书pem格式 示例值：-----BEGIN CERTIFICATE-----\nMIIBpTCCAUugAwIBAgIUVHl/MMu4SMSqDKEHmagHTg7kHO4wCQYHKoZIzj0EATAx\nMRAwDgYDVQQDDAdhYmMuY29tMRAwDgYDVQQKDAdhYmMuY29tMQ****++CSo4EF31yBTEEkfMM=\n-----END CERTIFICATE-----
Key	String	证书私钥 示例值：-----BEGIN PRIVATE KEY-----\nMIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgokysviOMJk43IY6s\nQpD6VUUAM8aU5RPyFTNUuJXN+JuhRANCAATJWrcGNiaU94X8JFEornursRSbx0VY\nT2XqoJyK+g2TdRdDQw8t9su9IQD5FAYwR+Uh5TNeIqJNq0DWLOcovUQ+\n-----END PRIVATE KEY-----
ExpireTime	String	证书过期时间 示例值：2022-08-31 05:45:00
CreateTime	String	证书上传时间 示例值：2023-02-21 13:56:20
IssueTime	String	证书签发时间 示例值：2022-08-21 05:45:00
CertSource	String	证书来源：native(kong自定义证书) ssl(ssl平台证书) 示例值：ssl
CertId	String	ssl平台证书Id 示例值：6767a862a4-8ce4

KongPassiveHealthCheck

Kong网关被动健康检查配置

被如下接口引用：DescribeUpstreamHealthCheckConfig, UpdateUpstreamHealthCheckConfig。

名称	类型	必选	描述
Type	String	否	后端target协议类型，被动健康检查支持http和tcp，主动健康检查支持http 示例值：http

KongRoutePreview

云原生网关路由信息

被如下接口引用：DescribeCloudNativeAPIGatewayRoutes。

名称	类型	必选	描述
ID	String	是	服务ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
Name	String	否	服务名字 示例值：test-service
Methods	Array of String	否	无 注意：此字段可能返回 null，表示取不到有效值。 示例值：GET
Paths	Array of String	否	无 注意：此字段可能返回 null，表示取不到有效值。 示例值：/v1/users
Hosts	Array of String	否	无 注意：此字段可能返回 null，表示取不到有效值。 示例值：tencent.com
Protocols	Array of String	否	无 示例值：http
PreserveHost	Boolean	否	无 示例值：true
HttpsRedirectStatusCode	Integer	否	无 示例值：426
StripPath	Boolean	否	无 示例值：true
CreatedTime	String	否	无 示例值：2024-11-25 10:49:23
ServiceName	String	否	服务名 示例值：learn
ServiceID	String	否	服务ID 示例值：2a212560-220a-46f6-b139-3238eb8ea041
DestinationPorts	Array of Integer	否	目的端口 示例值：8000
Headers	Array of KVMapping	否	路由的Headers
RequestBuffering	Boolean	否	是否缓存请求body，默认true 示例值：true
ResponseBuffering	Boolean	否	是否缓存响应body，默认true 示例值：true
RegexPriority	Integer	否	正则优先级 示例值：0

KongServiceDetail

云原生网关服务详细信息

被如下接口引用：DescribeOneCloudNativeAPIGatewayService。

名称	类型	必选	描述
ID	String	是	服务ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
Name	String	否	服务名字 示例值：test-service
Protocol	String	否	后端协议 示例值：http
Path	String	否	后端路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/v1/users
Timeout	Integer	否	后端延时，单位ms 示例值：5000
Retries	Integer	否	重试次数 示例值：0
Tags	Array of String	否	标签 注意：此字段可能返回 null，表示取不到有效值。 示例值：["test"]
UpstreamInfo	KongUpstreamInfo	否	后端配置
UpstreamType	String	否	后端类型 示例值：HostIP
Editable	Boolean	否	是否可编辑 示例值：true
CreatedTime	String	否	创建时间 示例值：2024-11-25 10:49:23

KongServiceLightPreview

云原生网关服务简洁预览信息

被如下接口引用：DescribeCloudNativeAPIGatewayServicesLight。

名称	类型	描述
ID	String	服务ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
Name	String	服务名字 示例值：test-service
UpstreamInfo	KongUpstreamInfo	后端配置
UpstreamType	String	后端类型 示例值：HostIP
CreatedTime	String	创建时间 示例值：2024-11-25 10:49:23
Path	String	请求路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/open
Protocol	String	后端协议 示例值：http
Retries	Integer	重试次数 示例值：1
Timeout	Integer	后端延时，单位ms 示例值：5000

KongServicePreview

云原生网关服务预览信息

被如下接口引用：DescribeCloudNativeAPIGatewayServices。

名称	类型	必选	描述
ID	String	是	服务ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
Name	String	否	服务名字 示例值：test-service
Tags	Array of String	否	标签 示例值：["test"]
UpstreamInfo	KongUpstreamInfo	否	后端配置
UpstreamType	String	否	后端类型 示例值：HostIP
CreatedTime	String	否	创建时间 示例值：2024-11-25 10:49:23
Editable	Boolean	否	是否可编辑 示例值：true
Path	String	否	请求路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/open

KongServiceRouteList

kong服务路由列表

被如下接口引用：DescribeCloudNativeAPIGatewayRoutes。

名称	类型	必选	描述
RouteList	Array of KongRoutePreview	否	无
TotalCount	Integer	否	总数 示例值：100

KongServices

kong实例的服务列表

被如下接口引用：DescribeCloudNativeAPIGatewayServices。

名称	类型	必选	描述
ServiceList	Array of KongServicePreview	否	kong实例的服务列表
TotalCount	Integer	否	列表总数 示例值：10

KongTarget

Kong Upstream中的Target

被如下接口引用：CreateCloudNativeAPIGatewayService, DescribeCloudNativeAPIGatewayUpstream, ModifyCloudNativeAPIGatewayService, UpdateUpstreamTargets。

名称	类型	必选	描述
Host	String	是	Host 示例值：8.8.8.8
Port	Integer	是	端口 示例值：100
Weight	Integer	是	权重 示例值：10
Health	String	否	健康状态 示例值：HEALTHY
CreatedTime	String	否	创建时间 示例值：2024-11-25 10:49:23
Source	String	否	Target的来源 示例值：AutoScaling
CvmInstanceId	String	否	CVM实例ID 示例值：ins-ze3124da
CvmInstanceName	String	否	CVM实例名称 示例值：在线学习服务
Tags	Array of String	否	target标签 示例值：learn

KongUpstreamInfo

服务的后端配置

被如下接口引用：CreateCloudNativeAPIGatewayService, DescribeCloudNativeAPIGatewayServices, DescribeCloudNativeAPIGatewayServicesLight, DescribeOneCloudNativeAPIGatewayService, ModifyCloudNativeAPIGatewayService。

名称	类型	必选	描述
Host	String	否	IP或域名 示例值：www.test.com
Port	Integer	否	端口 示例值：80
SourceID	String	否	服务来源ID 示例值：ins-102555d0
Namespace	String	否	命名空间 示例值：Default
ServiceName	String	否	服务（注册中心或Kubernetes中的服务）名字 示例值：demo-service
Targets	Array of KongTarget	否	服务后端类型是IPList时提供 注意：此字段可能返回 null，表示取不到有效值。
SourceType	String	否	服务来源类型 示例值：TKE
ScfType	String	否	SCF函数类型 示例值：event
ScfNamespace	String	否	SCF函数命名空间 示例值：Default
ScfLambdaName	String	否	SCF函数名 示例值：helloworld
ScfLambdaQualifier	String	否	SCF函数版本 示例值：$LATEST
SlowStart	Integer	否	冷启动时间，单位秒 示例值：60
Algorithm	String	否	负载均衡算法，默认为 round-robin，还支持 least-connections，consisten_hashing 示例值：round-robin
AutoScalingGroupID	String	否	CVM弹性伸缩组ID 示例值：as-4se0czf7
AutoScalingCvmPort	Integer	否	CVM弹性伸缩组端口 示例值：80
AutoScalingTatCmdStatus	String	否	CVM弹性伸缩组使用的CVM TAT命令状态 示例值：Normal
AutoScalingHookStatus	String	否	CVM弹性伸缩组生命周期挂钩状态 示例值：Normal
SourceName	String	否	服务来源的名字 示例值：tse-polaris
RealSourceType	String	否	精确的服务来源类型，新建服务来源时候传入的类型 示例值：TKE
HealthStatus	String	否	upstream健康状态HEALTHY（健康）, UNHEALTHY（异常）, HEALTHCHECKS_OFF（未开启）和NONE（不支持健康检查） 示例值：HEALTHY
ScfCamAuthEnable	Boolean	否	云函数是否开启CAM鉴权，不填时默认为开启(true) 示例值：true
ScfIsBase64Encoded	Boolean	否	云函数是否开启Base64编码，默认为false 示例值：false
ScfIsIntegratedResponse	Boolean	否	云函数是否开启响应集成，默认为false 示例值：false

KongUpstreamList

kong后端upstream列表

被如下接口引用：DescribeCloudNativeAPIGatewayUpstream。

名称	类型	必选	描述
UpstreamList	Array of KongUpstreamPreview	否	无

KongUpstreamPreview

云原生网关Upstream信息

被如下接口引用：DescribeCloudNativeAPIGatewayUpstream。

名称	类型	必选	描述
ID	String	是	服务ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
Name	String	否	服务名字 示例值：test-service
Target	Array of KongTarget	否	后端配置

LimitRule

参数限流的规则

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Filters	Array of RuleFilter	否	请求匹配条件 示例值：{"Key":"ip","Values":["8.8.8.8/24"]}
LimitBy	Array of KeyValue	否	参数限流依据组合 示例值：[{"Key":"ip","Value":""},{"Key":"header","Value":"host"}]
QpsThresholds	Array of QpsThreshold	否	限流阈值 示例值：[{"Unit":"second","Max":10000}]
AccurateQpsThresholds	Array of AccurateQpsThreshold	否	精确限流阈值

ListCloudNativeAPIGatewayResult

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

被如下接口引用：DescribeCloudNativeAPIGateways。

名称	类型	描述
TotalCount	Integer	总数。 示例值：1
GatewayList	Array of DescribeCloudNativeAPIGatewayResult	云原生API网关实例列表。

ListCloudNativeAPIGatewayStrategyBindingGroupInfoResult

获取云原生API网关实例策略绑定网关分组列表响应结果。

被如下接口引用：DescribeAutoScalerResourceStrategyBindingGroups。

名称	类型	描述
TotalCount	Integer	数量 示例值：1
GroupInfos	Array of CloudNativeAPIGatewayStrategyBindingGroupInfo	云原生API网关实例策略绑定网关分组列表

ListCloudNativeAPIGatewayStrategyResult

获取云原生API网关实例策略响应结果。

被如下接口引用：DescribeAutoScalerResourceStrategies。

名称	类型	描述
TotalCount	Integer	总数。 示例值：1
StrategyList	Array of CloudNativeAPIGatewayStrategy	云原生API网关实例策略列表。

ListFilter

列表过滤条件，模糊匹配

被如下接口引用：DescribeCloudNativeAPIGatewayCertificates, DescribeCloudNativeAPIGatewayRoutes, DescribeCloudNativeAPIGatewayServices, DescribeCloudNativeAPIGatewayServicesLight。

名称	类型	必选	描述
Key	String	否	过滤字段 示例值：name
Value	String	否	过滤值 示例值：user-stu

Location

新增Location字段，展示zone/region/campus

被如下接口引用：DescribeGovernanceInstances。

名称	类型	必选	描述
Region	String	否	大区 示例值：huanan
Zone	String	否	可用区 示例值：guangzhou
Campus	String	否	机房 示例值：guangzhou-1

Metadata

元数据信息

被如下接口引用：CreateGovernanceServices, DeleteGovernanceAliases, DeleteGovernanceInstances, DeleteGovernanceInstancesByHost, DeleteGovernanceServices, DescribeGovernanceAliases, DescribeGovernanceInstances, DescribeGovernanceNamespaces, DescribeGovernanceServiceContracts, DescribeGovernanceServices, ModifyGovernanceInstances, ModifyGovernanceServices。

名称	类型	必选	描述
Key	String	是	元数据键名。 示例值：name
Value	String	否	元数据键值。不填则默认为空字符串。 示例值：tom

NacosReplica

Nacos副本信息

被如下接口引用：DescribeNacosReplicas。

名称	类型	描述
Name	String	名称 示例值：name
Role	String	角色 示例值：leader
Status	String	状态 示例值：running
SubnetId	String	子网ID 示例值：subnet-id
Zone	String	可用区ID 示例值：ap-guangzhou-1
ZoneId	String	可用区ID 示例值：10001
VpcId	String	VPC ID 示例值：vpc-id

NacosServerInterface

nacos服务端接口列表，用于云监控

被如下接口引用：DescribeNacosServerInterfaces。

名称	类型	描述
Interface	String	接口名 示例值：GET:/nacos/v1/config

NativeGatewayServerGroup

云原生网关分组信息

被如下接口引用：DescribeNativeGatewayServerGroups。

名称	类型	描述
GroupId	String	云原生网关分组唯一id 示例值：group-xxaaa
Name	String	分组名 示例值：prod
Description	String	描述信息 示例值：现网
NodeConfig	CloudNativeAPIGatewayNodeConfig	节点规格、节点数信息
Status	String	网关分组状态。 示例值：Running
CreateTime	String	创建时间 示例值：2021-09-09 11:52:30
IsFirstGroup	Integer	是否是默认分组。 0：否。 1：是。 示例值：1
BindingStrategy	CloudNativeAPIGatewayStrategy	关联策略信息
GatewayId	String	网关实例 id 示例值：gateway-xxxx1234
InternetMaxBandwidthOut	Integer	带宽 示例值：4
ModifyTime	String	修改时间 示例值：2021-09-09 11:52:30
SubnetIds	String	子网id 示例值：subnet-xxxx1234
DefaultWeight	Integer	分组默认权重 示例值：10
ElasticNumber	Integer	弹性节点 示例值：0
SupportTOA	Boolean	是否支持TOA 示例值：false
SupportIPV6	Boolean	是否支持IPV6 示例值：false

NativeGatewayServerGroups

网关分组列表

被如下接口引用：DescribeNativeGatewayServerGroups。

名称	类型	描述
TotalCount	Integer	总数 示例值：20
GatewayGroupList	Array of NativeGatewayServerGroup	分组信息数组。

NativeGatewayServiceSourceItem

网关数据来源单个描述

被如下接口引用：DescribeNativeGatewayServiceSources。

名称	类型	描述
GatewayID	String	网关实例ID 示例值：gateway-xxx
SourceID	String	服务来源ID 示例值：nacos-xxx
SourceName	String	服务来源名称 示例值：nacos-xx
SourceType	String	服务来源类型 示例值：TSE Nacos｜TSE Consul｜TSE PolarisMesh｜Nacos｜Consul｜PolarisMesh
SourceInfo	SourceInfo	服务来源额外信息
CreateTime	String	创建时间 示例值：2022-08-06 12:34:56
ModifyTime	String	修改时间 示例值：2022-08-06 12:34:56

NetworkAccessControl

网络访问策略

被如下接口引用：DescribeCloudNativeAPIGatewayConfig, DescribePublicNetwork, ModifyConsoleNetwork, ModifyNetworkAccessStrategy。

名称	类型	必选	描述
Mode	String	是	访问模式：Whitelist|Blacklist 示例值：Whitelist
CidrWhiteList	Array of String	否	白名单列表 示例值：["0.0.0.0"]
CidrBlackList	Array of String	否	黑名单列表 示例值：["100.10.0.0/24"]

PolarisCLSTopicInfo

北极星日志主题信息

被如下接口引用：DescribeSREInstances。

名称	类型	必选	描述
LogSetId	String	否	日志集ID 示例值：log-id
LogSetName	String	否	日志集名称 示例值：log-name
TopicId	String	否	日志主题ID 示例值：topic-id
TopicName	String	否	日志主题名称 示例值：topic-name

PolarisLimiterAddress

查询Limiter的接入地址

被如下接口引用：DescribeSREInstanceAccessAddress。

名称	类型	描述
IntranetAddress	String	VPC接入IP列表 示例值：127.0.0.1

PublicAddressConfig

公网地址信息

被如下接口引用：DescribePublicAddressConfig。

名称	类型	描述
Vip	String	公网 ip 示例值：1.1.1.1
InternetMaxBandwidthOut	Integer	公网最大带宽 示例值：5
GroupId	String	公网所属分组 id 示例值：group-4se0czf7
GroupName	String	公网所属分组名 示例值：默认分组
NetworkId	String	公网负载均衡 id 示例值：network-1234adsf
Description	String	公网负载均衡描述 示例值：公网入口

QpsThreshold

云原生网关限流插件Qps阈值

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Unit	String	是	qps阈值控制维度,包含:second、minute、hour、day、month、year 示例值：second、minute、hour、day、month、year
Max	Integer	是	阈值 示例值：10

RateLimitResponse

云原生网关限流插件自定义响应

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Body	String	否	自定义响应体 示例值：hello
Headers	Array of KVMapping	否	Headers 示例值：[{key:"",value:""},]
HttpStatus	Integer	否	http状态码 示例值：200

ReleaseVersion

配置发布版本信息

被如下接口引用：DescribeConfigFileReleaseVersions。

名称	类型	必选	描述
Name	String	否	配置发布的版本 示例值：v1
Active	Boolean	否	是否生效 示例值：true
Id	String	否	配置发布的ID 示例值：config-id
Namespace	String	否	配置发布的命名空间 示例值：namespaceName
Group	String	否	配置发布的分组 示例值：groupName
FileName	String	否	配置发布的文件名 示例值：name

RouteWafStatus

路由 WAF 状态

被如下接口引用：DescribeWafProtection。

名称	类型	描述
Name	String	路由的名字 示例值：demo-route
Id	String	路由的 ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
Status	String	路由是否开启 WAF 防护 示例值：Open
Methods	Array of String	方法 示例值：["GET"]
Paths	Array of String	路径 示例值：["/"]
Hosts	Array of String	域名 示例值：["tencent.com"]
ServiceName	String	路由对应服务的名字 示例值：demo-service
ServiceId	String	路由对应服务的ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38202

RuleFilter

限流规则的Filter

被如下接口引用：CreateCloudNativeAPIGatewayRouteRateLimit, CreateCloudNativeAPIGatewayServiceRateLimit, DescribeCloudNativeAPIGatewayRouteRateLimit, DescribeCloudNativeAPIGatewayServiceRateLimit, ModifyCloudNativeAPIGatewayRouteRateLimit, ModifyCloudNativeAPIGatewayServiceRateLimit。

名称	类型	必选	描述
Key	String	否	限流条件的Key 示例值：ip
Values	Array of String	否	限流条件的Values 示例值：8.8.8.8/24
Operator	String	否	操作符 示例值：eq
Name	String	否	header或query对应的name 示例值：Auth

SREInstance

微服务注册引擎实例

被如下接口引用：DescribeSREInstances。

名称	类型	描述
InstanceId	String	实例ID 示例值：inst-12345678
Name	String	名称 示例值：instance-name
Edition	String	版本号 示例值：1.8.6
Status	String	状态, 枚举值:creating/create_fail/running/updating/update_fail/restarting/restart_fail/destroying/destroy_fail 示例值：creating
SpecId	String	规格ID 示例值：spec-12345678
Replica	Integer	副本数 示例值：3
Type	String	类型 示例值：consul
VpcId	String	Vpc iD 示例值：vpc-12345678
SubnetIds	Array of String	子网ID 示例值：["subnet-12345678"]
EnableStorage	Boolean	是否开启持久化存储 示例值：true
StorageType	String	数据存储方式 示例值：CLOUD_PREMIUM
StorageCapacity	Integer	云硬盘容量 示例值：10
Paymode	String	计费方式 示例值：POSTPAID
EKSClusterID	String	EKS集群的ID 示例值：cls-1234567
CreateTime	String	集群创建时间 示例值：2021-04-08 16:20:58
EnvInfos	Array of EnvInfo	环境配置信息列表
EngineRegion	String	引擎所在的区域 示例值：ap-beijing
EnableInternet	Boolean	注册引擎是否开启公网 示例值：true
VpcInfos	Array of VpcInfo	私有网络列表信息
ServiceGovernanceInfos	Array of ServiceGovernanceInfo	服务治理相关信息列表
Tags	Array of KVPair	实例的标签信息 示例值：[{"Key":"type","Value":"nacos"}]
EnableConsoleInternet	Boolean	引擎实例是否开启控制台公网访问地址 示例值：true
EnableConsoleIntranet	Boolean	引擎实例是否开启控制台内网访问地址 示例值：true
ConfigInfoVisible	Boolean	引擎实例是否展示参数配置页面 示例值：true
ConsoleDefaultPwd	String	引擎实例控制台默认密码 示例值：nacosxx
TradeType	Integer	交易付费类型，0后付费/1预付费 示例值：1
AutoRenewFlag	Integer	自动续费标记：0表示默认状态(用户未设置，即初始状态)， 1表示自动续费，2表示明确不自动续费 示例值：0
CurDeadline	String	预付费到期时间 示例值：2021-04-08 16:20:58
IsolateTime	String	隔离开始时间 示例值：2021-04-08 16:20:58
RegionInfos	Array of DescribeInstanceRegionInfo	实例地域相关的描述信息
EKSType	String	所在EKS环境，分为common和yunti 示例值：common
FeatureVersion	String	引擎的产品版本 示例值：STANDARD
EnableClientIntranet	Boolean	引擎实例是否开启客户端内网访问地址 示例值：false
StorageOption	Array of StorageOption	存储额外配置选项
ZookeeperRegionInfo	ZookeeperRegionInfo	Zookeeper的额外环境数据信息
DeployMode	String	部署架构 示例值：SingleRegion
GlobalType	String	全局属性 示例值：Global
GroupType	String	所属组类型 示例值：ClusterFederationGroup
GroupId	Array of String	组id 示例值：986b8507b256d967b8840b127511fbafc5e37c363be039b6270ae4da827b654a
IsMainRegion	Boolean	是否为主地域 示例值：true

ServiceGovernanceInfo

服务治理相关的信息

被如下接口引用：DescribeSREInstances。

名称	类型	必选	描述
EngineRegion	String	是	引擎所在的地域 示例值：ap-beijing
BoundK8SInfos	Array of BoundK8SInfo	否	服务治理引擎绑定的kubernetes集群信息
VpcInfos	Array of VpcInfo	否	服务治理引擎绑定的网络信息
AuthOpen	Boolean	否	当前实例鉴权是否开启 示例值：true
Features	Array of String	否	该实例支持的功能，鉴权就是 Auth 示例值：["Auth"]
MainPassword	String	否	主账户名默认为 polaris，该值为主账户的默认密码 示例值：主账户密码
PgwVpcInfos	Array of VpcInfo	否	服务治理pushgateway引擎绑定的网络信息
LimiterVpcInfos	Array of VpcInfo	否	服务治理限流server引擎绑定的网络信息
CLSTopics	Array of PolarisCLSTopicInfo	否	引擎关联CLS日志主题信息
SubPassword	String	否	子用户密码 示例值：sub@asdasd123

ServiceWafStatus

服务的 WAF 状态

被如下接口引用：DescribeWafProtection。

名称	类型	描述
Name	String	服务的名字 示例值：demo-service
Id	String	服务的 ID 示例值：916462a4-8ce4-4605-a7b7-66cd51c38201
Type	String	服务的类型 示例值：Kubernetes
Status	String	服务是否开启 WAF 防护 示例值：Open

SourceInfo

服务来源

被如下接口引用：CreateNativeGatewayServiceSource, DescribeNativeGatewayServiceSources, ModifyNativeGatewayServiceSource。

名称	类型	必选	描述
Addresses	Array of String	否	微服务引擎接入IP地址信息 示例值：["127.0.0.1:8080"]
VpcInfo	SourceInstanceVpcInfo	否	微服务引擎VPC信息
Auth	SourceInstanceAuth	否	微服务引擎鉴权信息

SourceInstanceAuth

实例鉴权信息

被如下接口引用：CreateNativeGatewayServiceSource, ModifyNativeGatewayServiceSource。

名称	类型	必选	描述
Username	String	否	用户名 示例值：tse
Password	String	否	账户密码 示例值：tse
AccessToken	String	否	访问凭据 token 示例值：tse

SourceInstanceVpcInfo

微服务引擎实例的VPC信息

被如下接口引用：CreateNativeGatewayServiceSource, ModifyNativeGatewayServiceSource。

名称	类型	必选	描述
VpcID	String	否	微服务引擎VPC信息 示例值：vpc-id
SubnetID	String	否	微服务引擎子网信息 示例值：subnet-id

StorageOption

存储的额外选项

被如下接口引用：CreateEngine, DescribeSREInstances。

名称	类型	必选	描述
Name	String	否	存储对象，分为snap和txn两种 示例值：snap
Type	String	否	存储类型，分为三类CLOUD_PREMIUM/CLOUD_SSD/CLOUD_SSD_PLUS，分别对应高性能云硬盘、SSD云硬盘、增强型SSD云硬盘 示例值：CLOUD_PREMIUM
Capacity	Integer	否	存储容量，[50, 3200]的范围 示例值：50

UpdateCloudNativeAPIGatewayResult

更新云原生API网关响应结果。

被如下接口引用：UpdateCloudNativeAPIGatewaySpec。

名称	类型	描述
GatewayId	String	云原生API网关ID。 示例值：gateway-xxxxxx
Status	String	云原生网关状态。 示例值：UpdatingSpec
TaskId	String	任务ID 示例值：task-xxxx1234

UpstreamHealthCheckConfig

云原生网关健康检查配置

被如下接口引用：DescribeUpstreamHealthCheckConfig, UpdateUpstreamHealthCheckConfig。

名称	类型	必选	描述
EnableActiveHealthCheck	Boolean	否	开启主动健康检查 示例值：true
ActiveHealthCheck	KongActiveHealthCheck	否	主动健康检查配置
EnablePassiveHealthCheck	Boolean	否	开启被动健康检查 示例值：true
PassiveHealthCheck	KongPassiveHealthCheck	否	被动健康检查配置
Successes	Integer	否	连续健康阈值，单位：次 示例值：5
Failures	Integer	否	连续异常阈值，单位：次 示例值：5
Timeouts	Integer	否	超时阈值，单位：次 示例值：5
HealthyHttpStatuses	Array of Integer	否	健康HTTP状态码 示例值：200
UnhealthyHttpStatuses	Array of Integer	否	异常HTTP状态码 示例值：500
ZeroWeightHeathCheck	Boolean	否	健康检查支持权重为0节点 示例值：false

VpcInfo

私有网络信息

被如下接口引用：CreateEngine, DescribeSREInstances。

名称	类型	必选	描述
VpcId	String	是	Vpc Id 示例值：vpc-xxxxxxxx
SubnetId	String	是	子网ID 示例值：subnet-xxxxxxxx
IntranetAddress	String	否	内网访问地址 示例值：xxxx.xx.xx.xx
LbSubnetId	String	否	负载均衡均衡接入点子网ID 示例值：subnet-xxxxxxxx

ZookeeperRegionInfo

Zookeeper的地域额外信息记录

被如下接口引用：DescribeSREInstances。

名称	类型	描述
DeployMode	String	部署架构信息 - SingleRegion: 普通单地域 - MultiRegion: 普通多地域场景 - MasterSlave: 两地域，主备地域场景 示例值：SingleRegion
MainRegion	ZookeeperRegionMyIdInfo	主地域的额外信息
OtherRegions	Array of ZookeeperRegionMyIdInfo	其他地域的额外信息

ZookeeperRegionMyIdInfo

Zookeeper的地域信息的 myid 信息记录

被如下接口引用：DescribeSREInstances。

名称	类型	描述
Region	String	地域信息 示例值：ap-guangzhou
MyIdStart	Integer	myid 的起始号段 示例值：101
MyIdEnd	Integer	myid 的结束号段 示例值：109

ZookeeperReplica

Zookeeper副本信息

被如下接口引用：DescribeZookeeperReplicas。

名称	类型	描述
Name	String	名称 示例值：zk-name
Role	String	角色 示例值：leading
Status	String	状态 示例值：Running
SubnetId	String	子网ID 示例值：subnet-id
Zone	String	可用区ID 示例值：gz
ZoneId	String	可用区ID 示例值：300001
AliasName	String	别名 示例值：zookeeper-0
VpcId	String	VPC ID 示例值：vpc-id

ZookeeperServerInterface

Zookeeper服务端接口列表，用于云监控

被如下接口引用：DescribeZookeeperServerInterfaces。

名称	类型	描述
Interface	String	接口名 示例值：getChildren