tencentcloud-sdk-nodejs
Version:
2,929 lines (2,926 loc) • 200 kB
TypeScript
/**
* DescribeNacosReplicas请求参数结构体
*/
export interface DescribeNacosReplicasRequest {
/**
* 引擎实例ID
*/
InstanceId: string;
/**
* 副本列表Limit
*/
Limit?: number;
/**
* 副本列表Offset
*/
Offset?: number;
}
/**
* DeleteWafDomains请求参数结构体
*/
export interface DeleteWafDomainsRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* WAF 防护域名列表
*/
Domains: Array<string>;
}
/**
* DescribeCloudNativeAPIGatewayNodes请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayNodesRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 实例分组id
*/
GroupId?: string;
/**
* 翻页获取多少个
*/
Limit?: number;
/**
* 翻页从第几个开始获取
*/
Offset?: number;
}
/**
* 服务别名结构信息
*/
export interface GovernanceAlias {
/**
* 服务别名
*/
Alias?: string;
/**
* 服务别名命名空间
*/
AliasNamespace?: string;
/**
* 服务别名指向的服务名
*/
Service?: string;
/**
* 服务别名指向的服务命名空间
*/
Namespace?: string;
/**
* 服务别名的描述信息
*/
Comment?: string;
/**
* 服务别名创建时间
*/
CreateTime?: string;
/**
* 服务别名修改时间
*/
ModifyTime?: string;
/**
* 服务别名ID
*/
Id?: string;
/**
* 该服务别名是否可以编辑
*/
Editable?: boolean;
}
/**
* DescribeCloudNativeAPIGatewayUpstream请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayUpstreamRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名字
*/
ServiceName: string;
}
/**
* 元数据信息
*/
export interface Metadata {
/**
* 元数据键名。
*/
Key: string;
/**
* 元数据键值。不填则默认为空字符串。
*/
Value?: string;
}
/**
* DescribeUpstreamHealthCheckConfig请求参数结构体
*/
export interface DescribeUpstreamHealthCheckConfigRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 网关服务名称
*/
Name: string;
}
/**
* Key/Value结构
*/
export interface KeyValue {
/**
* 条件的Key
注意:此字段可能返回 null,表示取不到有效值。
*/
Key?: string;
/**
* 条件的Value
注意:此字段可能返回 null,表示取不到有效值。
*/
Value?: string;
}
/**
* CreateNativeGatewayServerGroup请求参数结构体
*/
export interface CreateNativeGatewayServerGroupRequest {
/**
* 网关实例id。
只支持后付费实例
*/
GatewayId: string;
/**
* 网关分组名
*/
Name: string;
/**
* 节点配置
*/
NodeConfig: CloudNativeAPIGatewayNodeConfig;
/**
* 子网id
*/
SubnetId: string;
/**
* 描述信息
*/
Description?: string;
/**
* 公网带宽信息
*/
InternetMaxBandwidthOut?: number;
/**
* 公网配置。
*/
InternetConfig?: InternetConfig;
}
/**
* DescribeCloudNativeAPIGatewayCertificates请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayCertificatesRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 列表数量
*/
Limit?: number;
/**
* 列表offset
*/
Offset?: number;
/**
* 过滤条件,多个过滤条件之间是与的关系,支持BindDomain ,Name
*/
Filters?: Array<ListFilter>;
}
/**
* 删除云原生API网关响应结果。
*/
export interface DeleteCloudNativeAPIGatewayResult {
/**
* 云原生网关ID。
*/
GatewayId: string;
/**
* 云原生网关状态。
*/
Status: string;
}
/**
* CloseWafProtection请求参数结构体
*/
export interface CloseWafProtectionRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 防护资源的类型。
- Global 实例
- Service 服务
- Route 路由
- Object 对象
*/
Type: string;
/**
* 当资源类型 Type 是 Service 或 Route 的时候,传入的服务或路由的列表
*/
List?: Array<string>;
}
/**
* DescribeCloudNativeAPIGatewayNodes返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayNodesResponse {
/**
* 获取云原生网关节点列表结果。
*/
Result: DescribeCloudNativeAPIGatewayNodesResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudNativeAPIGateway返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayResponse {
/**
* 创建云原生API网关实例响应结果。
*/
Result?: CreateCloudNativeAPIGatewayResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUpstreamHealthCheckConfig返回参数结构体
*/
export interface DescribeUpstreamHealthCheckConfigResponse {
/**
* 健康检查配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: UpstreamHealthCheckConfig;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 网络访问策略
*/
export interface NetworkAccessControl {
/**
* 访问模式:Whitelist|Blacklist
*/
Mode: string;
/**
* 白名单列表
*/
CidrWhiteList?: Array<string>;
/**
* 黑名单列表
*/
CidrBlackList?: Array<string>;
}
/**
* 查询客户端公网信息
*/
export interface DescribePublicNetworkResult {
/**
* 网关实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayId?: string;
/**
* 网关分组ID
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupId?: string;
/**
* 客户端公网信息
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicNetwork?: CloudNativeAPIGatewayConfig;
}
/**
* 网关数据来源单个描述
*/
export interface NativeGatewayServiceSourceItem {
/**
* 网关实例ID
*/
GatewayID: string;
/**
* 服务来源ID
*/
SourceID: string;
/**
* 服务来源名称
*/
SourceName: string;
/**
* 服务来源类型
*/
SourceType: string;
/**
* 服务来源额外信息
*/
SourceInfo: SourceInfo;
/**
* 创建时间
*/
CreateTime: string;
/**
* 修改时间
*/
ModifyTime: string;
}
/**
* CreateNativeGatewayServiceSource返回参数结构体
*/
export interface CreateNativeGatewayServiceSourceResponse {
/**
* 创建是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudNativeAPIGatewayService请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayServiceRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名称
*/
Name: string;
/**
* 请求协议:
- https
- http
- tcp
- udp
*/
Protocol: string;
/**
* 超时时间,单位ms
*/
Timeout: number;
/**
* 重试次数
*/
Retries: number;
/**
* 服务类型:
- Kubernetes
- Registry
- IPList
- HostIP
- Scf
*/
UpstreamType: string;
/**
* 服务配置信息
*/
UpstreamInfo: KongUpstreamInfo;
/**
* 请求路径
*/
Path?: string;
}
/**
* ModifyConsoleNetwork请求参数结构体
*/
export interface ModifyConsoleNetworkRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 网络类型:
- Open 公网
- Internal 内网(暂不支持)
*/
NetworkType: string;
/**
* 开启Konga网络,不填时默认为Open
- Open,开启
- Close,关闭
*/
Operate?: string;
/**
* 访问控制策略
*/
AccessControl?: NetworkAccessControl;
}
/**
* 公网地址信息
*/
export interface PublicAddressConfig {
/**
* 公网 ip
注意:此字段可能返回 null,表示取不到有效值。
*/
Vip?: string;
/**
* 公网最大带宽
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetMaxBandwidthOut?: number;
/**
* 公网所属分组 id
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupId?: string;
/**
* 公网所属分组名
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupName?: string;
/**
* 公网负载均衡 id
注意:此字段可能返回 null,表示取不到有效值。
*/
NetworkId?: string;
/**
* 公网负载均衡描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
}
/**
* DescribeCloudNativeAPIGatewayServices请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayServicesRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 列表数量
*/
Limit?: number;
/**
* 列表 offset
*/
Offset?: number;
/**
* 过滤条件,多个过滤条件之间是与的关系,支持 name,upstreamType
*/
Filters?: Array<ListFilter>;
}
/**
* CreateCloudNativeAPIGatewayCanaryRule返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayCanaryRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteGovernanceNamespaces返回参数结构体
*/
export interface DeleteGovernanceNamespacesResponse {
/**
* 删除是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGatewayRoutes返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayRoutesResponse {
/**
* 无
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: KongServiceRouteList;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWafProtection返回参数结构体
*/
export interface DescribeWafProtectionResponse {
/**
* 保护状态
*/
Result?: DescribeWafProtectionResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeZookeeperReplicas请求参数结构体
*/
export interface DescribeZookeeperReplicasRequest {
/**
* 注册引擎实例ID
*/
InstanceId: string;
/**
* 副本列表Limit
*/
Limit?: number;
/**
* 副本列表Offset
*/
Offset?: number;
}
/**
* DescribeAutoScalerResourceStrategies返回参数结构体
*/
export interface DescribeAutoScalerResourceStrategiesResponse {
/**
* 获取云原生API网关实例弹性伸缩策略列表响应结果。
*/
Result?: ListCloudNativeAPIGatewayStrategyResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 获取云原生API网关基础信息响应结果。
*/
export interface DescribeCloudNativeAPIGatewayResult {
/**
* 云原生API网关ID。
*/
GatewayId?: string;
/**
* 云原生API网关状态。
*/
Status?: string;
/**
* 云原生API网关名。
*/
Name?: string;
/**
* 云原生API网关类型。
*/
Type?: string;
/**
* 实例版本:
- 2.4.1
- 2.5.1
*/
GatewayVersion?: string;
/**
* 云原生API网关节点信息。
*/
NodeConfig?: CloudNativeAPIGatewayNodeConfig;
/**
* 云原生API网关vpc配置。
*/
VpcConfig?: CloudNativeAPIGatewayVpcConfig;
/**
* 云原生API网关描述。
*/
Description?: string;
/**
* 云原生API网关创建时间。
*/
CreateTime?: string;
/**
* 实例的标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<InstanceTagInfo>;
/**
* 是否开启 cls 日志
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableCls?: boolean;
/**
* 付费模式,0表示后付费,1预付费
注意:此字段可能返回 null,表示取不到有效值。
*/
TradeType?: number;
/**
* 实例版本,当前支持开发版、标准版、专业版【TRIAL、STANDARD、PROFESSIONAL】
注意:此字段可能返回 null,表示取不到有效值。
*/
FeatureVersion?: string;
/**
* 公网出流量带宽,[1,2048]Mbps
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetMaxBandwidthOut?: number;
/**
* 自动续费标记,0表示默认状态(用户未设置,即初始状态);
1表示自动续费,2表示明确不自动续费(用户设置),若业务无续费概念或无需自动续费,需要设置为0
注意:此字段可能返回 null,表示取不到有效值。
*/
AutoRenewFlag?: number;
/**
* 到期时间,预付费时使用
注意:此字段可能返回 null,表示取不到有效值。
*/
CurDeadline?: string;
/**
* 隔离时间,实例隔离时使用
注意:此字段可能返回 null,表示取不到有效值。
*/
IsolateTime?: string;
/**
* 是否开启客户端公网。
注意:此字段可能返回 null,表示取不到有效值。
*/
EnableInternet?: boolean;
/**
* 实例实际的地域信息
注意:此字段可能返回 null,表示取不到有效值。
*/
EngineRegion?: string;
/**
* Ingress class名称
注意:此字段可能返回 null,表示取不到有效值。
*/
IngressClassName?: string;
/**
* 公网计费方式。可选取值 BANDWIDTH | TRAFFIC ,表示按带宽和按流量计费。
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetPayMode?: string;
/**
* 云原生API网关小版本号
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayMinorVersion?: string;
/**
* 实例监听的端口信息
注意:此字段可能返回 null,表示取不到有效值。
*/
InstancePort?: InstancePort;
/**
* 公网CLB默认类型
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerType?: string;
/**
* 公网IP地址列表
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicIpAddresses?: Array<string>;
}
/**
* 北极星日志主题信息
*/
export interface PolarisCLSTopicInfo {
/**
* 日志集ID
*/
LogSetId?: string;
/**
* 日志集名称
*/
LogSetName?: string;
/**
* 日志主题ID
*/
TopicId?: string;
/**
* 日志主题名称
*/
TopicName?: string;
}
/**
* DeleteCloudNativeAPIGatewayRoute返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayRouteResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayServiceRateLimit请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayServiceRateLimitRequest {
/**
* 网关Id
*/
GatewayId: string;
/**
* 服务名称,或服务ID
*/
Name: string;
}
/**
* 灰度规则列表
*/
export interface CloudAPIGatewayCanaryRuleList {
/**
* 灰度规则
注意:此字段可能返回 null,表示取不到有效值。
*/
CanaryRuleList?: Array<CloudNativeAPIGatewayCanaryRule>;
/**
* 总数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
}
/**
* ModifyUpstreamNodeStatus请求参数结构体
*/
export interface ModifyUpstreamNodeStatusRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 服务名称
*/
ServiceName: string;
/**
* 访问IP地址或域名
*/
Host: string;
/**
* 访问端口
*/
Port: number;
/**
* HEALTHY或UNHEALTHY
*/
Status: string;
}
/**
* 云原生网关Tse 限流插件配置
*/
export interface CloudNativeAPIGatewayRateLimitDetail {
/**
* 插件启用状态
*/
Enabled?: boolean;
/**
* qps阈值
*/
QpsThresholds?: Array<QpsThreshold>;
/**
* 需要进行流量控制的请求路径
注意:此字段可能返回 null,表示取不到有效值。
*/
Path?: string;
/**
* 需要进行流量控制的请求头Key
注意:此字段可能返回 null,表示取不到有效值。
*/
Header?: string;
/**
* 限流依据
ip service consumer credential path header
*/
LimitBy?: string;
/**
* 外部redis配置
注意:此字段可能返回 null,表示取不到有效值。
*/
ExternalRedis?: ExternalRedis;
/**
* 计数器策略
local 单机
redis 默认redis
external_redis 外部redis
注意:此字段可能返回 null,表示取不到有效值。
*/
Policy?: string;
/**
* 响应配置,响应策略为text
注意:此字段可能返回 null,表示取不到有效值。
*/
RateLimitResponse?: RateLimitResponse;
/**
* 请求转发地址
注意:此字段可能返回 null,表示取不到有效值。
*/
RateLimitResponseUrl?: string;
/**
* 响应策略
url请求转发
text 响应配置
default 直接返回
*/
ResponseType?: string;
/**
* 是否隐藏限流客户端响应头
*/
HideClientHeaders?: boolean;
/**
* 排队时间
*/
LineUpTime?: number;
/**
* 是否开启请求排队
*/
IsDelay?: boolean;
/**
* 基础限流
注意:此字段可能返回 null,表示取不到有效值。
*/
BasicLimitQpsThresholds?: Array<QpsThreshold>;
/**
* 参数限流的规则
注意:此字段可能返回 null,表示取不到有效值。
*/
LimitRules?: Array<LimitRule>;
}
/**
* DescribeConfigFileRelease请求参数结构体
*/
export interface DescribeConfigFileReleaseRequest {
/**
* TSE实例id
*/
InstanceId: string;
/**
* 命名空间名称
*/
Namespace?: string;
/**
* 配置分组名称
*/
Group?: string;
/**
* 配置文件名称
*/
Name?: string;
/**
* 配置文件发布名称
*/
ReleaseName?: string;
/**
* 配置文件发布Id
*/
Id?: string;
}
/**
* DescribeCloudNativeAPIGatewayConfig请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayConfigRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 分组id,不填时为默认分组
*/
GroupId?: string;
}
/**
* Kong Upstream中的Target
*/
export interface KongTarget {
/**
* Host
*/
Host: string;
/**
* 端口
*/
Port: number;
/**
* 权重
*/
Weight: number;
/**
* 健康状态
*/
Health?: string;
/**
* 创建时间
*/
CreatedTime?: string;
/**
* Target的来源
*/
Source?: string;
/**
* CVM实例ID
*/
CvmInstanceId?: string;
/**
* CVM实例名称
*/
CvmInstanceName?: string;
/**
* target标签
*/
Tags?: Array<string>;
}
/**
* 实例鉴权信息
*/
export interface SourceInstanceAuth {
/**
* 用户名
注意:此字段可能返回 null,表示取不到有效值。
*/
Username?: string;
/**
* 账户密码
注意:此字段可能返回 null,表示取不到有效值。
*/
Password?: string;
/**
* 访问凭据 token
注意:此字段可能返回 null,表示取不到有效值。
*/
AccessToken?: string;
}
/**
* 扩容策略
*/
export interface AutoScalerPolicy {
/**
* 类型,Pods
*/
Type?: string;
/**
* 数量
*/
Value?: number;
/**
* 扩容周期
*/
PeriodSeconds?: number;
}
/**
* DescribeNacosServerInterfaces返回参数结构体
*/
export interface DescribeNacosServerInterfacesResponse {
/**
* 接口总个数
*/
TotalCount?: number;
/**
* 接口列表
*/
Content?: Array<NacosServerInterface>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 键值对
*/
export interface KVMapping {
/**
* key
*/
Key?: string;
/**
* value
*/
Value?: string;
}
/**
* 定时伸缩配置参数
*/
export interface CloudNativeAPIGatewayStrategyCronScalerConfigParam {
/**
* 定时伸缩周期
*/
Period?: string;
/**
* 定时伸缩开始时间
*/
StartAt?: string;
/**
* 定时伸缩目标节点数,不超过指标伸缩中定义的最大节点数
*/
TargetReplicas?: number;
/**
* 定时伸缩cron表达式,无需输入
*/
Crontab?: string;
}
/**
* 环境具体信息
*/
export interface EnvInfo {
/**
* 环境名称
*/
EnvName: string;
/**
* 环境对应的网络信息
*/
VpcInfos: Array<VpcInfo>;
/**
* 云硬盘容量
*/
StorageCapacity: number;
/**
* 运行状态
*/
Status?: string;
/**
* Admin service 访问地址
*/
AdminServiceIp?: string;
/**
* Config service访问地址
*/
ConfigServiceIp?: string;
/**
* 是否开启config-server公网
*/
EnableConfigInternet?: boolean;
/**
* config-server公网访问地址
*/
ConfigInternetServiceIp?: string;
/**
* 规格ID
*/
SpecId?: string;
/**
* 环境的节点数
*/
EnvReplica?: number;
/**
* 环境运行的节点数
*/
RunningCount?: number;
/**
* 环境别名
*/
AliasEnvName?: string;
/**
* 环境描述
*/
EnvDesc?: string;
/**
* 客户端带宽
*/
ClientBandWidth?: number;
/**
* 客户端内网开关
*/
EnableConfigIntranet?: boolean;
}
/**
* DeleteGovernanceInstances请求参数结构体
*/
export interface DeleteGovernanceInstancesRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 要删除的服务实例信息。
*/
GovernanceInstances: Array<GovernanceInstanceUpdate>;
}
/**
* 配置文件模板
*/
export interface ConfigFileTemplate {
/**
* 配置文件模板id
*/
Id?: number;
/**
* 配置文件模板名称
*/
Name?: string;
/**
* 配置文件模板内容
*/
Content?: string;
/**
* 配置文件模板格式
*/
Format?: string;
/**
* 配置文件模板注释
*/
Comment?: string;
/**
* 配置文件模板创建时间
*/
CreateTime?: string;
/**
* 配置文件模板创建者
*/
CreateBy?: string;
/**
* 配置文件模板修改时间
*/
ModifyTime?: string;
/**
* 配置文件模板修改者
*/
ModifyBy?: string;
}
/**
* 网关实例策略
*/
export interface CloudNativeAPIGatewayStrategy {
/**
* 策略ID
*/
StrategyId?: string;
/**
* 策略名称
注意:此字段可能返回 null,表示取不到有效值。
*/
StrategyName?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 更新时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ModifyTime?: string;
/**
* 策略描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 弹性伸缩配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Config?: CloudNativeAPIGatewayStrategyAutoScalerConfig;
/**
* 网关实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayId?: string;
/**
* 定时伸缩配置
注意:此字段可能返回 null,表示取不到有效值。
*/
CronConfig?: CloudNativeAPIGatewayStrategyCronScalerConfig;
/**
* 最大节点数
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
MaxReplicas?: number;
}
/**
* UpdateEngineInternetAccess返回参数结构体
*/
export interface UpdateEngineInternetAccessResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayRouteRateLimit请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayRouteRateLimitRequest {
/**
* 网关Id
*/
GatewayId: string;
/**
* 路由Id,或路由名称。
不支持“未命名”
*/
Id: string;
}
/**
* 指标伸缩行为
*/
export interface AutoScalerBehavior {
/**
* 扩容行为配置
*/
ScaleUp?: AutoScalerRules;
/**
* 缩容行为配置
*/
ScaleDown?: AutoScalerRules;
}
/**
* 列表过滤条件,模糊匹配
*/
export interface ListFilter {
/**
* 过滤字段
*/
Key?: string;
/**
* 过滤值
*/
Value?: string;
}
/**
* CreateCloudNativeAPIGatewayPublicNetwork返回参数结构体
*/
export interface CreateCloudNativeAPIGatewayPublicNetworkResponse {
/**
* 返回结果
*/
Result?: CreatePublicNetworkResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyGovernanceServices请求参数结构体
*/
export interface ModifyGovernanceServicesRequest {
/**
* tse 实例 id。
*/
InstanceId: string;
/**
* 服务信息。
*/
GovernanceServices: Array<GovernanceServiceInput>;
}
/**
* DescribeConfigFileReleases返回参数结构体
*/
export interface DescribeConfigFileReleasesResponse {
/**
* 总条数
*/
TotalCount?: number;
/**
* 发布列表
*/
Releases?: Array<ConfigFileRelease>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayServiceRateLimit返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayServiceRateLimitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGovernanceServices请求参数结构体
*/
export interface CreateGovernanceServicesRequest {
/**
* tse 实例 id。
*/
InstanceId: string;
/**
* 服务信息。
*/
GovernanceServices: Array<GovernanceServiceInput>;
}
/**
* ModifyCloudNativeAPIGatewayServiceRateLimit请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayServiceRateLimitRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名称,或服务ID
*/
Name: string;
/**
* 限流配置
*/
LimitDetail: CloudNativeAPIGatewayRateLimitDetail;
}
/**
* 云原生网关分组信息
*/
export interface NativeGatewayServerGroup {
/**
* 云原生网关分组唯一id
*/
GroupId?: string;
/**
* 分组名
*/
Name?: string;
/**
* 描述信息
*/
Description?: string;
/**
* 节点规格、节点数信息
*/
NodeConfig?: CloudNativeAPIGatewayNodeConfig;
/**
* 网关分组状态。
*/
Status?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 是否是默认分组。
0:否。
1:是。
*/
IsFirstGroup?: number;
/**
* 关联策略信息
注意:此字段可能返回 null,表示取不到有效值。
*/
BindingStrategy?: CloudNativeAPIGatewayStrategy;
/**
* 网关实例 id
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayId?: string;
/**
* 带宽
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetMaxBandwidthOut?: number;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ModifyTime?: string;
/**
* 子网id
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetIds?: string;
/**
* 分组默认权重
注意:此字段可能返回 null,表示取不到有效值。
*/
DefaultWeight?: number;
/**
* 弹性节点
注意:此字段可能返回 null,表示取不到有效值。
*/
ElasticNumber?: number;
}
/**
* ModifyNetworkAccessStrategy返回参数结构体
*/
export interface ModifyNetworkAccessStrategyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestartSREInstance请求参数结构体
*/
export interface RestartSREInstanceRequest {
/**
* 微服务引擎实例Id
*/
InstanceId: string;
/**
* 重启的环境类型(PROD,DEV,UAT等)
*/
EnvTypes?: Array<string>;
/**
* 指定需要重启的实例节点(当前仅支持zk单节点重启)
*/
NodeName?: string;
}
/**
* UnbindAutoScalerResourceStrategyFromGroups请求参数结构体
*/
export interface UnbindAutoScalerResourceStrategyFromGroupsRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId: string;
/**
* 网关分组ID列表
*/
GroupIds: Array<string>;
}
/**
* 配置文件持久化
*/
export interface ConfigFilePersistent {
/**
* 文件编码
*/
Encoding?: string;
/**
* 文件下发路径
*/
Path?: string;
/**
* 文件后置命令
*/
PostCmd?: string;
}
/**
* DeleteCloudNativeAPIGatewayPublicNetwork请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayPublicNetworkRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 分组id,kong类型时必填
*/
GroupId?: string;
/**
* 公网类型
- IPV4 (默认值)
- IPV6
*/
InternetAddressVersion?: string;
/**
* 公网ip,存在多个公网时必填
*/
Vip?: string;
}
/**
* 配置发布版本信息
*/
export interface ReleaseVersion {
/**
* 配置发布的版本
*/
Name?: string;
/**
* 是否生效
*/
Active?: boolean;
/**
* 配置发布的ID
*/
Id?: string;
/**
* 配置发布的命名空间
*/
Namespace?: string;
/**
* 配置发布的分组
*/
Group?: string;
/**
* 配置发布的文件名
*/
FileName?: string;
}
/**
* 查询Limiter的接入地址
*/
export interface PolarisLimiterAddress {
/**
* VPC接入IP列表
*/
IntranetAddress?: string;
}
/**
* CreateGovernanceAlias请求参数结构体
*/
export interface CreateGovernanceAliasRequest {
/**
* tse实例id。
*/
InstanceId: string;
/**
* 服务别名
*/
Alias: string;
/**
* 服务别名命名空间
*/
AliasNamespace: string;
/**
* 服务别名所指向的服务名
*/
Service: string;
/**
* 服务别名所指向的命名空间
*/
Namespace: string;
/**
* 服务别名描述
*/
Comment?: string;
}
/**
* ModifyCloudNativeAPIGatewayService请求参数结构体
*/
export interface ModifyCloudNativeAPIGatewayServiceRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名称
*/
Name: string;
/**
* 请求协议:
- https
- http
- tcp
- udp
*/
Protocol: string;
/**
* 超时时间,单位ms
*/
Timeout: number;
/**
* 重试次数
*/
Retries: number;
/**
* 服务类型:
- Kubernetes
- Registry
- IPList
- HostIP
- Scf
*/
UpstreamType: string;
/**
* 服务配置
*/
UpstreamInfo: KongUpstreamInfo;
/**
* 服务ID
*/
ID: string;
/**
* 请求路径
*/
Path?: string;
}
/**
* DescribeAutoScalerResourceStrategyBindingGroups请求参数结构体
*/
export interface DescribeAutoScalerResourceStrategyBindingGroupsRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId: string;
/**
* 查询偏移量
*/
Offset?: number;
/**
* 查询数量限制
*/
Limit?: number;
}
/**
* DescribeConfigFilesByGroup返回参数结构体
*/
export interface DescribeConfigFilesByGroupResponse {
/**
* 记录总数量
*/
TotalCount?: number;
/**
* 配置文件列表
*/
ConfigFiles?: Array<ConfigFile>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWafProtection请求参数结构体
*/
export interface DescribeWafProtectionRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 防护资源的类型。
- Global 实例
- Service 服务
- Route 路由
- Object 对象
* @deprecated
*/
Type?: string;
/**
* 防护资源类型列表,支持查询多个类型(Global、Service、Route、Object)。为空时,默认查询Global类型。
*/
TypeList?: Array<string>;
}
/**
* DescribeAutoScalerResourceStrategies请求参数结构体
*/
export interface DescribeAutoScalerResourceStrategiesRequest {
/**
* 网关实例ID
*/
GatewayId: string;
/**
* 策略ID
*/
StrategyId?: string;
}
/**
* 限流规则的Filter
*/
export interface RuleFilter {
/**
* 限流条件的Key
注意:此字段可能返回 null,表示取不到有效值。
*/
Key?: string;
/**
* 限流条件的Values
注意:此字段可能返回 null,表示取不到有效值。
*/
Values?: Array<string>;
/**
* 操作符
注意:此字段可能返回 null,表示取不到有效值。
*/
Operator?: string;
/**
* header或query对应的name
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
}
/**
* DescribeGovernanceInstances请求参数结构体
*/
export interface DescribeGovernanceInstancesRequest {
/**
* 实例所在的服务名。
*/
Service: string;
/**
* 实例所在命名空间名。
*/
Namespace: string;
/**
* tse实例id。
*/
InstanceId: string;
/**
* 根据实例ip过滤,多个ip使用英文逗号分隔。
*/
Host?: string;
/**
* 根据实例版本过滤。
*/
InstanceVersion?: string;
/**
* 根据实例协议过滤。
*/
Protocol?: string;
/**
* 根据实例健康状态过滤。false:表示不健康,true:表示健康。
*/
HealthStatus?: boolean;
/**
* 根据实例隔离状态过滤。false:表示非隔离,true:表示隔离中。
*/
Isolate?: boolean;
/**
* 根据元数据信息过滤。目前只支持一组元数据键值,若传了多个键值对,只会以第一个过滤。
*/
Metadatas?: Array<Metadata>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 地域
*/
Location?: Location;
}
/**
* DescribeGovernanceServiceContracts请求参数结构体
*/
export interface DescribeGovernanceServiceContractsRequest {
/**
* 北极星引擎实例ID
*/
InstanceId: string;
/**
* 分页偏移量
*/
Offset?: number;
/**
* 分页条数
*/
Limit?: number;
/**
* 命名空间
*/
Namespace?: string;
/**
* 服务名
*/
Service?: string;
/**
* 契约名称
*/
Name?: string;
/**
* 契约版本
*/
ContractVersion?: string;
/**
* 契约协议
*/
Protocol?: string;
/**
* 是否只展示基本信息
*/
Brief?: boolean;
}
/**
* 实例信息
*/
export interface GovernanceInstanceUpdate {
/**
* 实例所在服务名。
*/
Service: string;
/**
* 实例服务所在命名空间。
*/
Namespace: string;
/**
* 实例负载均衡权重信息。不填默认为100。
*/
Weight?: number;
/**
* 实例默认健康信息。不填默认为健康。
*/
Healthy?: boolean;
/**
* 实例隔离信息。不填默认为非隔离。
*/
Isolate?: boolean;
/**
* 实例ip。
*/
Host?: string;
/**
* 实例监听端口。
*/
Port?: number;
/**
* 实例使用协议。不填默认为空。
*/
Protocol?: string;
/**
* 实例版本。不填默认为空。
*/
InstanceVersion?: string;
/**
* 是否启用健康检查。不填默认不启用。
*/
EnableHealthCheck?: boolean;
/**
* 上报心跳时间间隔。若 EnableHealthCheck 为不启用,则此参数不生效;若 EnableHealthCheck 启用,此参数不填,则默认 ttl 为 5s。
*/
Ttl?: number;
/**
* 治理中心服务实例id。
*/
Id?: string;
/**
* 元数据信息。
*/
Metadatas?: Array<Metadata>;
}
/**
* 公网负载均衡配置
*/
export interface InternetConfig {
/**
* 公网地址版本,可选:"IPV4" | "IPV6" 。不填默认 IPV4 。
*/
InternetAddressVersion?: string;
/**
* 公网付费类型,当前仅可选:"BANDWIDTH"。不填默认为 "BANDWIDTH"
*/
InternetPayMode?: string;
/**
* 公网带宽。
*/
InternetMaxBandwidthOut?: number;
/**
* 负载均衡描述
*/
Description?: string;
/**
* 负载均衡的规格类型,支持clb.c2.medium、clb.c3.small、clb.c3.medium、clb.c4.small、clb.c4.medium、clb.c4.large、clb.c4.xlarge,不传为共享型。
*/
SlaType?: string;
/**
* 负载均衡是否多可用区
*/
MultiZoneFlag?: boolean;
/**
* 主可用区
*/
MasterZoneId?: string;
/**
* 备可用区
*/
SlaveZoneId?: string;
}
/**
* kong后端upstream列表
*/
export interface KongUpstreamList {
/**
* 无
注意:此字段可能返回 null,表示取不到有效值。
*/
UpstreamList?: Array<KongUpstreamPreview>;
}
/**
* DescribeConfigFiles请求参数结构体
*/
export interface DescribeConfigFilesRequest {
/**
* 命名空间名称
*/
Namespace: string;
/**
* TSE实例id
*/
InstanceId?: string;
/**
* 组名
*/
Group?: string;
/**
* 配置文件名称
*/
Name?: string;
/**
* 标签列表
*/
Tags?: Array<ConfigFileTag>;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 配置文件ID
*/
Id?: string;
}
/**
* DeleteCloudNativeAPIGatewayRoute请求参数结构体
*/
export interface DeleteCloudNativeAPIGatewayRouteRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 路由的ID或名字,不支持名称“未命名”
*/
Name: string;
}
/**
* DescribeConfigFileReleases请求参数结构体
*/
export interface DescribeConfigFileReleasesRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 条数
*/
Limit: number;
/**
* 偏移量
*/
Offset: number;
/**
* 命名空间
*/
Namespace?: string;
/**
* 配置分组
*/
Group?: string;
/**
* 文件名称
*/
FileName?: string;
/**
* 只保护处于使用状态
*/
OnlyUse?: boolean;
/**
* 发布名称
*/
ReleaseName?: string;
/**
* 排序字段,mtime/version/name
,默认version
*/
OrderField?: string;
/**
* 排序,asc/desc,默认 desc
*/
OrderDesc?: string;
/**
* 配置发布ID
*/
Id?: string;
}
/**
* ModifyCloudNativeAPIGatewayServiceRateLimit返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayServiceRateLimitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 弹性伸缩策略
*/
export interface CloudNativeAPIGatewayStrategyAutoScalerConfig {
/**
* 最大副本数
*/
MaxReplicas?: number;
/**
* 指标列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Metrics?: Array<CloudNativeAPIGatewayStrategyAutoScalerConfigMetric>;
/**
* 是否开启指标伸缩
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Enabled?: boolean;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
CreateTime?: string;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
ModifyTime?: string;
/**
* 弹性策略ID
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
StrategyId?: string;
/**
* 指标配置ID
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
AutoScalerId?: string;
/**
* 指标伸缩行为配置
注意:此字段可能返回 null,表示取不到有效值。
*/
Behavior?: AutoScalerBehavior;
}
/**
* 灰度规则中的条件配置
*/
export interface CloudNativeAPIGatewayCanaryRuleCondition {
/**
* 条件类型,支持 path, method, query, header, cookie, body 和 system。
注意:此字段可能返回 null,表示取不到有效值。
*/
Type: string;
/**
* 参数名
注意:此字段可能返回 null,表示取不到有效值。
*/
Key?: string;
/**
* 操作符,支持 "le", "eq", "lt", "ne", "ge", "gt", "regex", "exists", "in", "not in", "prefix" ,"exact", "regex" 等
注意:此字段可能返回 null,表示取不到有效值。
*/
Operator?: string;
/**
* 目标参数值
注意:此字段可能返回 null,表示取不到有效值。
*/
Value?: string;
/**
* 分隔符,当 Operator 为 in 或者 not in 时生效。支持值为英文逗号,英文分号,空格,换行符。
注意:此字段可能返回 null,表示取不到有效值。
*/
Delimiter?: string;
/**
* 全局配置 Id
注意:此字段可能返回 null,表示取不到有效值。
*/
GlobalConfigId?: string;
/**
* 全局配置名称
注意:此字段可能返回 null,表示取不到有效值。
*/
GlobalConfigName?: string;
}
/**
* DescribeGovernanceNamespaces请求参数结构体
*/
export interface DescribeGovernanceNamespacesRequest {
/**
* tse实例id
*/
InstanceId: string;
/**
* 根据命名空间名称过滤。
*/
Name?: string;
/**
* 是否开启同步到全局注册中心
*/
SyncToGlobalRegistry?: string;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
}
/**
* DescribeSREInstances返回参数结构体
*/
export interface DescribeSREInstancesResponse {
/**
* 总数量
*/
TotalCount?: number;
/**
* 实例记录
*/
Content?: Array<SREInstance>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 指标伸缩的规则
*/
export interface AutoScalerRules {
/**
* 稳定窗口时间,扩容时默认0,缩容时默认300
*/
StabilizationWindowSeconds?: number;
/**
* 选择策略依据
*/
SelectPolicy?: string;
/**
* 扩缩容策略
*/
Policies?: Array<AutoScalerPolicy>;
}
/**
* 服务契约接口定义
*/
export interface GovernanceInterfaceDescription {
/**
* 契约接口ID
*/
ID?: string;
/**
* 方法名称
*/
Method?: string;
/**
* 路径/接口名称
*/
Path?: string;
/**
* 内容
*/
Content?: string;
/**
* 创建来源
*/
Source?: string;
/**
* 信息摘要
*/
Revision?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 修改时间
*/
ModifyTime?: string;
/**
* 接口名称
*/
Name?: string;
}
/**
* CreateCloudNativeAPIGatewayServiceRateLimit请求参数结构体
*/
export interface CreateCloudNativeAPIGatewayServiceRateLimitRequest {
/**
* 网关ID
*/
GatewayId: string;
/**
* 服务名称,或服务ID
*/
Name: string;
/**
* 限流配置
*/
LimitDetail: CloudNativeAPIGatewayRateLimitDetail;
}
/**
* ModifyNativeGatewayServerGroup请求参数结构体
*/
export interface ModifyNativeGatewayServerGroupRequest {
/**
* 云原生API网关实例ID。
*/
GatewayId: string;
/**
* 网关分组 id
*/
GroupId: string;
/**
* 云原生API网关名字, 最多支持60个字符。
*/
Name?: string;
/**
* 云原生API网关描述信息, 最多支持120个字符。
*/
Description?: string;
}
/**
* 获取云原生API网关实例协议端口列表响应结果
*/
export interface DescribeGatewayInstancePortResult {
/**
* 云原生API网关ID
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayId?: string;
/**
* 网关实例协议端口列表
注意:此字段可能返回 null,表示取不到有效值。
*/
GatewayInstancePortList?: Array<GatewayInstanceSchemeAndPorts>;
}
/**
* ModifyConsoleNetwork返回参数结构体
*/
export interface ModifyConsoleNetworkResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWafDomains返回参数结构体
*/
export interface DescribeWafDomainsResponse {
/**
* 已被 WAF 防护域名
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: DescribeWafDomainsResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSREInstanceAccessAddress请求参数结构体
*/
export interface DescribeSREInstanceAccessAddressRequest {
/**
* 注册引擎实例Id
*/
InstanceId?: string;
/**
* VPC ID
*/
VpcId?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 引擎其他组件名称(pushgateway、polaris-limiter)
*/
Workload?: string;
/**
* 部署地域
*/
EngineRegion?: string;
}
/**
* ModifyGovernanceInstances返回参数结构体
*/
export interface ModifyGovernanceInstancesResponse {
/**
* 修改是否成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCloudNativeAPIGatewayPublicNetwork返回参数结构体
*/
export interface DeleteCloudNativeAPIGatewayPublicNetworkResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrUpdateConfigFileAndRelease请求参数结构体
*/
export interface CreateOrUpdateConfigFileAndReleaseRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* 配置文件列表详情
*/
ConfigFilePublishInfo: ConfigFilePublishInfo;
/**
* 控制开启校验配置版本是否已经存在
*/
StrictEnable?: boolean;
}
/**
* Apollo 环境配置参数
*/
export interface ApolloEnvParam {
/**
* 环境名称
*/
Name: string;
/**
* 环境内引擎的节点规格 ID
-1C2G
-2C4G
兼容原spec-xxxxxx形式的规格ID
*/
EngineResourceSpec: string;
/**
* 环境内引擎的节点数量
*/
EngineNodeNum: number;
/**
* 配置存储空间大小,以GB为单位
*/
StorageCapacity: number;
/**
* VPC ID。在 VPC 的子网内分配一个 IP 作为 ConfigServer 的访问地址
*/
VpcId: string;
/**
* 子网 ID。在 VPC 的子网内分配一个 IP 作为 ConfigServer 的访问地址
*/
SubnetId: string;
/**
* 环境描述
*/
EnvDesc?: string;
}
/**
* DeleteNativeGatewayServiceSource返回参数结构体
*/
export interface DeleteNativeGatewayServiceSourceResponse {
/**
* 结果
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGatewayServiceRateLimit请求参数结构体
*/
export interface DescribeCloudNativeAPIGatewayServiceRateLimitRequest {
/**
* 网关Id
*/
GatewayId: string;
/**
* 服务名称,或服务ID。
*/
Name: string;
}
/**
* 含百分比流量配置的服务
*/
export interface CloudNativeAPIGatewayBalancedService {
/**
* 服务 ID,作为入参时,必填
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceID?: string;
/**
* 服务名称,作为入参时,无意义
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceName?: string;
/**
* Upstream 名称,作为入参时,无意义
注意:此字段可能返回 null,表示取不到有效值。
*/
UpstreamName?: string;
/**
* 百分比,10 即 10%,范围0-100
注意:此字段可能返回 null,表示取不到有效值。
*/
Percent?: number;
}
/**
* DescribeConfigFileGroups返回参数结构体
*/
export interface DescribeConfigFileGroupsResponse {
/**
* 列表总数量
*/
TotalCount?: number;
/**
* 配置文件组列表
*/
ConfigFileGroups?: Array<ConfigFileGroup>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 定时伸缩策略配置
*/
export interface CloudNativeAPIGatewayStrategyCronScalerConfig {
/**
* 是否开启定时伸缩
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Enabled?: boolean;
/**
* 定时伸缩配置参数列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Params?: Array<CloudNativeAPIGatewayStrategyCronScalerConfigParam>;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
CreateTime?: string;
/**
* 修改时间
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
ModifyTime?: string;
/**
* 弹性策略ID
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
StrategyId?: string;
}
/**
* UpdateEngineInternetAccess请求参数结构体
*/
export interface UpdateEngineInternetAccessRequest {
/**
* 引擎ID
*/
InstanceId: string;
/**
* 引擎类型
*/
EngineType: string;
/**
* 是否开启客户端公网访问,true开 false关
*/
EnableClientInternetAccess?: boolean;
}
/**
* DeleteNativeGatewayServerGroup返回参数结构体
*/
export interface DeleteNativeGatewayServerGroupResponse {
/**
* 删除信息
*/
Result?: DeleteNativeGatewayServerGroupResult;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudNativeAPIGatewayCertificate返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayCertificateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSREInstanceAccessAddress返回参数结构体
*/
export interface DescribeSREInstanceAccessAddressResponse {
/**
* 内网访问地址
*/
IntranetAddress?: string;
/**
* 公网访问地址
*/
InternetAddress?: string;
/**
* apollo多环境公网ip
*/
EnvAddressInfos?: Array<EnvAddressInfo>;
/**
* 控制台公网访问地址
*/
ConsoleInternetAddress?: string;
/**
* 控制台内网访问地址
*/
ConsoleIntranetAddress?: string;
/**
* 客户端公网带宽
*/
InternetBandWidth?: number;
/**
* 控制台公网带宽
*/
ConsoleInternetBandWidth?: number;
/**
* 北极星限流server节点接入IP
注意:此字段可能返回 null,表示取不到有效值。
*/
LimiterAddressInfos?: Array<PolarisLimiterAddress>;
/**
* InternetAddress 的公网 CLB 多可用区信息
*/
CLBMultiRegion?: CLBMultiRegion;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConfigFile请求参数结构体
*/
export interface CreateConfigFileRequest {
/**
* TSE 实例id
*/
InstanceId: string;
/**
* 配置文件列表详情
*/
ConfigFile: ConfigFile;
}
/**
* DescribeConfigFiles返回参数结构体
*/
export interface DescribeConfigFilesResponse {
/**
* 分页总数量
*/
TotalCount?: number;
/**
* 配置文件列表
*/
ConfigFiles?: Array<ConfigFile>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCloudNativeAPIGatewayServices返回参数结构体
*/
export interface DescribeCloudNativeAPIGatewayServicesResponse {
/**
* 无
注意:此字段可能返回 null,表示取不到有效值。
*/
Result?: KongServices;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateNativeGatewayServiceSource请求参数结构体
*/
export interface CreateNativeGatewayServiceSourceRequest {
/**
* 网关实例ID
*/
GatewayID: string;
/**
* 服务来源类型,参考值:
- TSE-Nacos
- TSE-Consul
- TSE-PolarisMesh
- Customer-Nacos
- Customer-Consul
- Customer-PolarisMesh
- TSF
- TKE
- EKS
- PrivateDNS
- Customer-DNS
*/
SourceType: string;
/**
* 服务来源实例ID,当SourceType的值不为PrivateDNS或Customer-DNS时,必填
*/
SourceID?: string;
/**
* 服务来源实例名称,当SourceType的值不为PrivateDNS时,必填
*/
SourceName?: string;
/**
* 服务来源实例额外信息
*/
SourceInfo?: SourceInfo;
}
/**
* 云原生网关限流插件Qps阈值
*/
export interface QpsThreshold {
/**
* qps阈值控制维度,包含:second、minute、hour、day、month、year
*/
Unit: string;
/**
* 阈值
*/
Max: number;
}
/**
* 治理中心服务入参
*/
export interface GovernanceServiceInput {
/**
* 服务名。
*/
Name: string;
/**
* 服务所属命名空间。
*/
Namespace: string;
/**
* 服务描述信息。
*/
Comment?: string;
/**
* 服务元数据。
*/
Metadatas?: Array<Metadata>;
/**
* 服务所属部门。
*/
Department?: string;
/**
* 服务所属业务。
*/
Business?: string;
/**
* 被添加进来可以操作此命名空间的用户ID列表
*/
UserIds?: Array<string>;
/**
* 被添加进来可以操作此命名空间的用户组ID列表
*/
GroupIds?: Array<string>;
/**
* 从操作此命名空间的用户组ID列表被移除的ID列表
*/
RemoveUserIds?: Array<string>;
/**
* 从可以操作此命名空间的用户组ID列表中被移除的ID列表
*/
RemoveGroupIds?: Array<string>;
/**
* 该服务对哪些命名空间可见
*/
ExportTo?: Array<string>;
/**
* 是否开启同步到全局注册中心
*/
SyncToGlobalRegistry?: boolean;
}
/**
* 私有网络信息
*/
export interface VpcInfo {
/**
* Vpc Id
*/
VpcId: string;
/**
* 子网ID
*/
SubnetId: string;
/**
* 内网访问地址
*/
IntranetAddress?: string;
/**
* 负载均衡均衡接入点子网ID
*/
LbSubnetId?: string;
}
/**
* 配置文件
*/
export interface ConfigFile {
/**
* 配置文件id
*/
Id?: number;
/**
* 配置文件名称
*/
Name?: string;
/**
* 配置文件命名空间
*/
Namespace?: string;
/**
* 配置文件组
*/
Group?: string;
/**
* 配置文件内容
*/
Content?: string;
/**
* 配置文件格式
*/
Format?: string;
/**
* 配置文件注释
*/
Comment?: string;
/**
* 配置文件状态
*/
Status?: string;
/**
* 配置文件标签数组
*/
Tags?: Array<ConfigFileTag>;
/**
* 配置文件创建时间
*/
CreateTime?: string;
/**
* 配置文件创建者
*/
CreateBy?: string;
/**
* 配置文件修改时间
*/
ModifyTime?: string;
/**
* 配置文件修改者
*/
ModifyBy?: string;
/**
* 配置文件发布时间
*/
ReleaseTime?: string;
/**
* 配置文件发布者
*/
ReleaseBy?: string;
/**
* 配置文件类型
*/
ConfigFileSupportedClient?: number;
/**
* 配置文件持久化
*/
ConfigFilePersistent?: ConfigFilePersistent;
}
/**
* ModifyNativeGatewayServiceSource请求参数结构体
*/
export interface ModifyNativeGatewayServiceSourceRequest {
/**
* 网关实例ID
*/
GatewayID: string;
/**
* 服务来源实例ID
*/
SourceID: string;
/**
* 服务来源名称
*/
SourceName: string;
/**
* 服务来源实例额外信息
*/
SourceInfo?: SourceInfo;
}
/**
* Kong网关主动健康检查配置
*/
export interface KongActiveHealthCheck {
/**
* 主动健康检查健康探测间隔,单位:秒,0表示不开启
注意:此字段可能返回 null,表示取不到有效值。
*/
HealthyInterval?: number;
/**
* 主动健康检查异常探测间隔,单位:秒,0表示不开启
注意:此字段可能返回 null,表示取不到有效值。
*/
UnHealthyInterval?: number;
/**
* 在 GET HTTP 请求中使用的路径,以作为主动运行状况检查的探测器运行。默认: ”/”。
注意:此字段可能返回 null,表示取不到有效值。
*/
HttpPath?: string;
/**
* GET HTTP 请求的超时时间,单位:秒。默认 60。
注意:此字段可能返回 null,表示取不到有效值。
*/
Timeout?: number;
}
/**
* ModifyCloudNativeAPIGatewayCanaryRule返回参数结构体
*/
export interface ModifyCloudNativeAPIGatewayCanaryRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云原生网关服务预览信息
*/
export interface KongServicePreview {
/**
* 服务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ID: string;
/**
* 服务名字
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<string>;
/**
* 后端配置
注意:此字段可能返回 null,表示取不到有效值。
*/
UpstreamInfo?: KongUpstreamInfo;
/**
* 后端类型
注意:此字段可能返回 null,表示取不到有效值。
*/
UpstreamType?: string;
/**
* 创建时间
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedTime?: string;
/**
* 是否可编辑
注意:此字段可能返回 null,表示取不到有效值。
*/
Editable?: boolean;
/**
* 请求路径
注意:此字段可能返回 null,表示取不到有效值。
*/
Path?: string;
}
/**
* nacos服务端接口列表,用于云监控
*/
export interface NacosServerInterface {
/**
* 接口名
*/
Interface?: string;
}
/**
* 引擎实例的标签信息
*/
export interface InstanceTagInfo {
/**
* 标签键
*/
TagKey?: string;
/**
* 标签值
*/
TagValue?: string;
}
/**
* UnbindAutoScalerResourceStrategyFromGroups返回参数结构体
*/
export interface UnbindAutoScalerResourceStrategyFromGroupsResponse {
/**
* 是否成功
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateUpstreamTarget