tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,357 lines (2,207 loc) • 158 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 云原生网关限流插件参数限流的精确Qps阈值 */
declare interface AccurateQpsThreshold {
/** qps阈值控制维度,包含:second、minute、hour、day、month、year */
Unit: string;
/** 全局配置ID */
GlobalConfigId: string;
}
/** Apollo 环境配置参数 */
declare 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;
}
/** 指标伸缩行为 */
declare interface AutoScalerBehavior {
/** 扩容行为配置 */
ScaleUp?: AutoScalerRules;
/** 缩容行为配置 */
ScaleDown?: AutoScalerRules;
}
/** 扩容策略 */
declare interface AutoScalerPolicy {
/** 类型,Pods */
Type?: string;
/** 数量 */
Value?: number;
/** 扩容周期 */
PeriodSeconds?: number;
}
/** 指标伸缩的规则 */
declare interface AutoScalerRules {
/** 稳定窗口时间,扩容时默认0,缩容时默认300 */
StabilizationWindowSeconds?: number;
/** 选择策略依据 */
SelectPolicy?: string;
/** 扩缩容策略 */
Policies?: AutoScalerPolicy[];
}
/** 服务治理引擎绑定的kubernetes信息 */
declare interface BoundK8SInfo {
/** 绑定的kubernetes集群ID */
BoundClusterId: string;
/** 绑定的kubernetes的集群类型,分tke和eks两种 */
BoundClusterType: string;
/** 服务同步模式,all为全量同步,demand为按需同步 */
SyncMode?: string;
/** 绑定的kubernetes集群所在地域 */
BindRegion?: string;
}
/** CLB多可用区信息 */
declare interface CLBMultiRegion {
/** 是否启用多可用区 */
CLBMultiZoneFlag?: boolean;
/** 主可用区信息 */
CLBMasterZone?: string;
/** 备可用区信息 */
CLBSlaveZone?: string;
}
/** 灰度规则 Priority - Rule */
declare interface CanaryPriorityRule {
/** 优先级 */
Priority?: number;
/** 灰度规则配置 */
CanaryRule?: CloudNativeAPIGatewayCanaryRule;
}
/** 证书信息 */
declare interface CertificateInfo {
/** 唯一id */
Id?: string;
}
/** 灰度规则列表 */
declare interface CloudAPIGatewayCanaryRuleList {
/** 灰度规则 */
CanaryRuleList?: CloudNativeAPIGatewayCanaryRule[];
/** 总数 */
TotalCount?: number;
}
/** 含百分比流量配置的服务 */
declare interface CloudNativeAPIGatewayBalancedService {
/** 服务 ID,作为入参时,必填 */
ServiceID?: string;
/** 服务名称,作为入参时,无意义 */
ServiceName?: string;
/** Upstream 名称,作为入参时,无意义 */
UpstreamName?: string;
/** 百分比,10 即 10%,范围0-100 */
Percent?: number;
}
/** 灰度规则 */
declare interface CloudNativeAPIGatewayCanaryRule {
/** 优先级,值范围为 0 到 100;值越大,优先级越高;不同规则间优先级不可重复 */
Priority: number;
/** 是否启用规则 */
Enabled: boolean;
/** 参数匹配条件 */
ConditionList?: CloudNativeAPIGatewayCanaryRuleCondition[];
/** 服务的流量百分比配置 */
BalancedServiceList?: CloudNativeAPIGatewayBalancedService[] | null;
/** 归属服务 ID */
ServiceId?: string;
/** 归属服务名称 */
ServiceName?: string;
/** 灰度规则类别Standard|Lane */
RuleType?: string;
/** 全链路灰度策略多个条件之间的匹配方式,与AND,或OR */
MatchType?: string;
/** 泳道组ID */
GroupId?: string;
/** 泳道组名称 */
GroupName?: string;
/** 泳道ID */
LaneId?: string;
/** 泳道名称 */
LaneName?: string;
/** 泳道匹配规则:严格STRICT|宽松PERMISSIVE */
MatchMode?: string;
/** 泳道标签 */
LaneTag?: string;
}
/** 灰度规则中的条件配置 */
declare interface CloudNativeAPIGatewayCanaryRuleCondition {
/** 条件类型,支持 path, method, query, header, cookie, body 和 system。 */
Type: string;
/** 参数名 */
Key?: string;
/** 操作符,支持 "le", "eq", "lt", "ne", "ge", "gt", "regex", "exists", "in", "not in", "prefix" ,"exact", "regex" 等 */
Operator?: string;
/** 目标参数值 */
Value?: string;
/** 分隔符,当 Operator 为 in 或者 not in 时生效。支持值为英文逗号,英文分号,空格,换行符。 */
Delimiter?: string;
/** 全局配置 Id */
GlobalConfigId?: string;
/** 全局配置名称 */
GlobalConfigName?: string;
}
/** 云原生API网关配置信息。 */
declare interface CloudNativeAPIGatewayConfig {
/** 控制台类型。 */
ConsoleType?: string;
/** HTTP链接地址。 */
HttpUrl?: string;
/** HTTPS链接地址。 */
HttpsUrl?: string;
/** 网络类型, Open|Internal。 */
NetType?: string;
/** 管理员用户名。 */
AdminUser?: string;
/** 管理员密码。 */
AdminPassword?: string;
/** 网络状态, Open|Closed|Updating */
Status?: string;
/** 网络访问策略 */
AccessControl?: NetworkAccessControl | null;
/** 内网子网 ID */
SubnetId?: string;
/** 内网VPC ID */
VpcId?: string;
/** 负载均衡的描述 */
Description?: string;
/** 负载均衡的规格类型 */
SlaType?: string;
/** clb规格名称 */
SlaName?: string;
/** clb vip */
Vip?: string;
/** 带宽 */
InternetMaxBandwidthOut?: number;
/** 是否多可用区 */
MultiZoneFlag?: boolean;
/** 主可用区 */
MasterZoneId?: string;
/** 备可用区 */
SlaveZoneId?: string;
/** 主可用区名称 */
MasterZoneName?: string;
/** 备可用区名称 */
SlaveZoneName?: string;
/** 网络 id */
NetworkId?: string;
/** 是否为新 ipv6 CLB */
IPV6FullChain?: boolean;
}
/** 云原生API网关节点信息。 */
declare interface CloudNativeAPIGatewayNode {
/** 云原生网关节点 id */
NodeId?: string;
/** 节点 ip */
NodeIp?: string;
/** Zone id */
ZoneId?: string;
/** Zone */
Zone?: string;
/** 分组ID */
GroupId?: string;
/** 分组名 */
GroupName?: string;
/** 状态 */
Status?: string;
/** 节点权重 */
Weight?: number;
/** 是否默认权重 */
IsDefaultWeight?: boolean;
}
/** 云原生API网关节点配置。 */
declare interface CloudNativeAPIGatewayNodeConfig {
/** 节点配置, 1c2g|2c4g|4c8g|8c16g。 */
Specification: string;
/** 节点数量,2-9。 */
Number: number;
}
/** 云原生网关Tse 限流插件配置 */
declare interface CloudNativeAPIGatewayRateLimitDetail {
/** 插件启用状态 */
Enabled?: boolean;
/** qps阈值 */
QpsThresholds?: QpsThreshold[];
/** 需要进行流量控制的请求路径 */
Path?: string;
/** 需要进行流量控制的请求头Key */
Header?: string;
/** 限流依据ip service consumer credential path header */
LimitBy?: string;
/** 外部redis配置 */
ExternalRedis?: ExternalRedis;
/** 计数器策略 local 单机redis 默认redisexternal_redis 外部redis */
Policy?: string;
/** 响应配置,响应策略为text */
RateLimitResponse?: RateLimitResponse;
/** 请求转发地址 */
RateLimitResponseUrl?: string;
/** 响应策略url请求转发text 响应配置default 直接返回 */
ResponseType?: string;
/** 是否隐藏限流客户端响应头 */
HideClientHeaders?: boolean;
/** 排队时间 */
LineUpTime?: number;
/** 是否开启请求排队 */
IsDelay?: boolean;
/** 基础限流 */
BasicLimitQpsThresholds?: QpsThreshold[] | null;
/** 参数限流的规则 */
LimitRules?: LimitRule[] | null;
}
/** 网关实例策略 */
declare interface CloudNativeAPIGatewayStrategy {
/** 策略ID */
StrategyId?: string;
/** 策略名称 */
StrategyName?: string;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
ModifyTime?: string;
/** 策略描述 */
Description?: string;
/** 弹性伸缩配置 */
Config?: CloudNativeAPIGatewayStrategyAutoScalerConfig;
/** 网关实例ID */
GatewayId?: string;
/** 定时伸缩配置 */
CronConfig?: CloudNativeAPIGatewayStrategyCronScalerConfig;
/** 最大节点数 */
MaxReplicas?: number | null;
}
/** 弹性伸缩策略 */
declare interface CloudNativeAPIGatewayStrategyAutoScalerConfig {
/** 最大副本数 */
MaxReplicas?: number;
/** 指标列表 */
Metrics?: CloudNativeAPIGatewayStrategyAutoScalerConfigMetric[] | null;
/** 是否开启指标伸缩 */
Enabled?: boolean | null;
/** 创建时间 */
CreateTime?: string | null;
/** 修改时间 */
ModifyTime?: string | null;
/** 弹性策略ID */
StrategyId?: string | null;
/** 指标配置ID */
AutoScalerId?: string | null;
/** 指标伸缩行为配置 */
Behavior?: AutoScalerBehavior | null;
}
/** 弹性伸缩配置指标 */
declare interface CloudNativeAPIGatewayStrategyAutoScalerConfigMetric {
/** 指标类型- Resource */
Type?: string;
/** 指标资源名称- cpu- memory */
ResourceName?: string;
/** 指标目标类型,目前只支持百分比Utilization */
TargetType?: string;
/** 指标目标值 */
TargetValue?: number;
}
/** 策略绑定的网关分组信息 */
declare interface CloudNativeAPIGatewayStrategyBindingGroupInfo {
/** 网关分组ID */
GroupId?: string;
/** 节点配置 */
NodeConfig?: CloudNativeAPIGatewayNodeConfig;
/** 绑定时间 */
BindTime?: string;
/** 网关分组名称 */
GroupName?: string;
/** 绑定状态 */
Status?: string;
}
/** 定时伸缩策略配置 */
declare interface CloudNativeAPIGatewayStrategyCronScalerConfig {
/** 是否开启定时伸缩 */
Enabled?: boolean | null;
/** 定时伸缩配置参数列表 */
Params?: CloudNativeAPIGatewayStrategyCronScalerConfigParam[] | null;
/** 创建时间 */
CreateTime?: string | null;
/** 修改时间 */
ModifyTime?: string | null;
/** 弹性策略ID */
StrategyId?: string | null;
}
/** 定时伸缩配置参数 */
declare interface CloudNativeAPIGatewayStrategyCronScalerConfigParam {
/** 定时伸缩周期 */
Period?: string;
/** 定时伸缩开始时间 */
StartAt?: string;
/** 定时伸缩目标节点数,不超过指标伸缩中定义的最大节点数 */
TargetReplicas?: number;
/** 定时伸缩cron表达式,无需输入 */
Crontab?: string;
}
/** 云原生API网关vpc配置。 */
declare interface CloudNativeAPIGatewayVpcConfig {
/** 私有网络ID。 */
VpcId?: string;
/** 子网ID。 */
SubnetId?: string;
}
/** 配置文件 */
declare interface ConfigFile {
/** 配置文件id */
Id?: number;
/** 配置文件名称 */
Name?: string;
/** 配置文件命名空间 */
Namespace?: string;
/** 配置文件组 */
Group?: string;
/** 配置文件内容 */
Content?: string;
/** 配置文件格式 */
Format?: string;
/** 配置文件注释 */
Comment?: string;
/** 配置文件状态 */
Status?: string;
/** 配置文件标签数组 */
Tags?: ConfigFileTag[];
/** 配置文件创建时间 */
CreateTime?: string;
/** 配置文件创建者 */
CreateBy?: string;
/** 配置文件修改时间 */
ModifyTime?: string;
/** 配置文件修改者 */
ModifyBy?: string;
/** 配置文件发布时间 */
ReleaseTime?: string;
/** 配置文件发布者 */
ReleaseBy?: string;
/** 配置文件类型 */
ConfigFileSupportedClient?: number;
/** 配置文件持久化 */
ConfigFilePersistent?: ConfigFilePersistent;
/** 是否开启加密算法 */
Encrypted?: boolean;
/** 加密算法 */
EncryptAlgo?: string;
}
/** 配置文件组 */
declare interface ConfigFileGroup {
/** 配置文件组id */
Id?: number;
/** 配置文件组名称 */
Name?: string;
/** 命名空间 */
Namespace?: string;
/** 备注 */
Comment?: string;
/** 创建时间 */
CreateTime?: string;
/** 创建者 */
CreateBy?: string;
/** 修改时间 */
ModifyTime?: string;
/** 修改者 */
ModifyBy?: string;
/** 文件数 */
FileCount?: number;
/** 关联用户,link_users */
UserIds?: string[];
/** 组id,link_groups */
GroupIds?: string[];
/** remove_link_users */
RemoveUserIds?: string[];
/** remove_link_groups */
RemoveGroupIds?: string[];
/** 是否可编辑 */
Editable?: boolean;
/** 归属者 */
Owner?: string;
/** 部门 */
Department?: string;
/** 业务 */
Business?: string;
/** 配置文件组标签 */
ConfigFileGroupTags?: ConfigFileGroupTag[];
}
/** 配置文件标签 */
declare interface ConfigFileGroupTag {
/** key-value 键 */
Key?: string;
/** key-value 值 */
Value?: string;
}
/** 配置文件持久化 */
declare interface ConfigFilePersistent {
/** 文件编码 */
Encoding?: string;
/** 文件下发路径 */
Path?: string;
/** 文件后置命令 */
PostCmd?: string;
}
/** 发布详情 */
declare interface ConfigFilePublishInfo {
/** 发布名称 */
ReleaseName?: string;
/** 命名空间 */
Namespace?: string;
/** 发布组 */
Group?: string;
/** 文件名 */
FileName?: string;
/** 内容 */
Content?: string;
/** 描述 */
Comment?: string;
/** 格式 */
Format?: string;
/** 创建者 */
CreateBy?: string;
/** 修改者 */
ModifyBy?: string;
/** 标签 */
Tags?: ConfigFileTag[];
}
/** 配置文件发布 */
declare interface ConfigFileRelease {
/** 配置文件发布id */
Id?: number;
/** 配置文件发布名称 */
Name?: string;
/** 配置文件发布命名空间 */
Namespace?: string;
/** 配置文件发布组 */
Group?: string;
/** 配置文件发布文件名称 */
FileName?: string;
/** 配置文件发布内容 */
Content?: string;
/** 配置文件发布注释 */
Comment?: string;
/** 配置文件发布Md5 */
Md5?: string;
/** 配置文件发布版本 */
Version?: number;
/** 配置文件发布创建时间 */
CreateTime?: string;
/** 配置文件发布创建者 */
CreateBy?: string;
/** 配置文件发布修改时间 */
ModifyTime?: string;
/** 配置文件发布修改者 */
ModifyBy?: string;
/** 发布描述 */
ReleaseDescription?: string;
/** 是否生效 */
Active?: boolean;
/** 格式 */
Format?: string;
/** 配置文件ID */
ConfigFileId?: string;
/** 配置文件类型 */
ConfigFileSupportedClient?: number;
/** 配置文件持久化 */
ConfigFilePersistent?: ConfigFilePersistent;
}
/** 配置发布删除 */
declare interface ConfigFileReleaseDeletion {
/** 命名空间 */
Namespace?: string;
/** 配置分组 */
Group?: string;
/** 文件名称 */
FileName?: string;
/** 发布版本 */
ReleaseVersion?: string;
/** 配置发布ID */
Id?: number;
}
/** 配置文件发布历史 */
declare interface ConfigFileReleaseHistory {
/** 配置文件发布历史记录id */
Id?: number;
/** 配置文件发布历史名称 */
Name?: string;
/** 配置文件发布历史命名空间 */
Namespace?: string;
/** 配置文件发布历史组 */
Group?: string;
/** 配置文件发布历史名称 */
FileName?: string;
/** 配置文件发布历史内容 */
Content?: string;
/** 配置文件发布历史格式 */
Format?: string;
/** 配置文件发布历史注释 */
Comment?: string;
/** 配置文件发布历史Md5 */
Md5?: string;
/** 配置文件发布历史类型 */
Type?: string;
/** 配置文件发布历史状态 */
Status?: string;
/** 配置文件发布历史标签组 */
Tags?: ConfigFileTag[];
/** 配置文件发布创建时间 */
CreateTime?: string;
/** 配置文件发布创建者 */
CreateBy?: string;
/** 配置文件发布修改时间 */
ModifyTime?: string;
/** 配置文件发布修改者 */
ModifyBy?: string;
/** 发布描述 */
ReleaseDescription?: string;
/** 原因,用于失败时原因展示 */
ReleaseReason?: string;
/** 配置文件类型 */
ConfigFileSupportedClient?: number;
/** 配置文件持久化 */
ConfigFilePersistent?: ConfigFilePersistent;
}
/** 配置文件标签 */
declare interface ConfigFileTag {
/** key-value 键 */
Key?: string;
/** key-value 值 */
Value?: string;
}
/** 配置文件模板 */
declare interface ConfigFileTemplate {
/** 配置文件模板id */
Id?: number;
/** 配置文件模板名称 */
Name?: string;
/** 配置文件模板内容 */
Content?: string;
/** 配置文件模板格式 */
Format?: string;
/** 配置文件模板注释 */
Comment?: string;
/** 配置文件模板创建时间 */
CreateTime?: string;
/** 配置文件模板创建者 */
CreateBy?: string;
/** 配置文件模板修改时间 */
ModifyTime?: string;
/** 配置文件模板修改者 */
ModifyBy?: string;
}
/** 创建云原生API网关响应结果。 */
declare interface CreateCloudNativeAPIGatewayResult {
/** 云原生API网关ID。 */
GatewayId?: string;
/** 云原生网关状态。 */
Status?: string;
/** 任务ID */
TaskId?: string;
}
/** 创建网关分组信息 */
declare interface CreateCloudNativeAPIGatewayServerGroupResult {
/** 网关实例id */
GatewayId?: string;
/** 分组id */
GroupId?: string;
/** 状态 */
Status?: string;
/** 任务ID */
TaskId?: string;
}
/** 创建云原生网关服务结果 */
declare interface CreateGatewayServiceResult {
/** 网关服务ID */
ServiceId?: string;
}
/** 创建kong客户端公网结果 */
declare interface CreatePublicNetworkResult {
/** 网关实例ID */
GatewayId?: string;
/** 分组ID */
GroupId?: string;
/** 客户端公网网络ID */
NetworkId?: string;
}
/** 删除云原生API网关响应结果。 */
declare interface DeleteCloudNativeAPIGatewayResult {
/** 云原生网关ID。 */
GatewayId: string;
/** 云原生网关状态。 */
Status: string;
}
/** 删除网关实例结果 */
declare interface DeleteNativeGatewayServerGroupResult {
/** 网关实例id */
GatewayId?: string;
/** 网关分组id */
GroupId?: string;
/** 删除状态 */
Status?: string;
/** 任务ID */
TaskId?: string;
}
/** 获取云原生API网关实例网络配置结果。 */
declare interface DescribeCloudNativeAPIGatewayConfigResult {
/** 网关实例ID。 */
GatewayId?: string;
/** 分组网络配置列表。 */
ConfigList?: CloudNativeAPIGatewayConfig[];
/** 分组子网信息 */
GroupSubnetId?: string;
/** 分组VPC信息 */
GroupVpcId?: string;
/** 分组ID */
GroupId?: string;
}
/** 获取网关节点信息 */
declare interface DescribeCloudNativeAPIGatewayNodesResult {
/** 获取云原生API网关节点列表响应结果。 */
TotalCount: number;
/** 云原生API网关节点列表。 */
NodeList: CloudNativeAPIGatewayNode[];
}
/** 获取云原生API网关基础信息响应结果。 */
declare 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;
/** 实例的标签信息 */
Tags?: InstanceTagInfo[];
/** 是否开启 cls 日志 */
EnableCls?: boolean;
/** 付费模式,0表示后付费,1预付费 */
TradeType?: number;
/** 实例版本,当前支持开发版、标准版、专业版【TRIAL、STANDARD、PROFESSIONAL】 */
FeatureVersion?: string;
/** 公网出流量带宽,[1,2048]Mbps */
InternetMaxBandwidthOut?: number;
/** 自动续费标记,0表示默认状态(用户未设置,即初始状态);1表示自动续费,2表示明确不自动续费(用户设置),若业务无续费概念或无需自动续费,需要设置为0 */
AutoRenewFlag?: number;
/** 到期时间,预付费时使用 */
CurDeadline?: string;
/** 隔离时间,实例隔离时使用 */
IsolateTime?: string;
/** 是否开启客户端公网。 */
EnableInternet?: boolean;
/** 实例实际的地域信息 */
EngineRegion?: string;
/** Ingress class名称 */
IngressClassName?: string;
/** 公网计费方式。可选取值 BANDWIDTH | TRAFFIC ,表示按带宽和按流量计费。 */
InternetPayMode?: string;
/** 云原生API网关小版本号 */
GatewayMinorVersion?: string;
/** 实例监听的端口信息 */
InstancePort?: InstancePort;
/** 公网CLB默认类型 */
LoadBalancerType?: string;
/** 公网IP地址列表 */
PublicIpAddresses?: string[];
/** 是否开启删除保护 */
DeleteProtect?: boolean;
}
/** 获取云原生API网关实例协议端口列表响应结果 */
declare interface DescribeGatewayInstancePortResult {
/** 云原生API网关ID */
GatewayId?: string;
/** 网关实例协议端口列表 */
GatewayInstancePortList?: GatewayInstanceSchemeAndPorts[];
}
/** 根据公网IP查询云原生网关实例信息出参 */
declare interface DescribeInstanceInfoByIpResult {
/** 实例id */
GatewayId?: string;
/** 分组id */
GroupId?: string;
}
/** 实例地域信息描述 */
declare interface DescribeInstanceRegionInfo {
/** 引擎部署地域信息 */
EngineRegion?: string;
/** 引擎在该地域的副本数 */
Replica?: number;
/** 引擎在该地域的规格id */
SpecId?: string;
/** 客户端内网的网络信息 */
IntranetVpcInfos?: VpcInfo[];
/** 控制台内网的网络信息 */
ConsoleIntranetVpcInfos?: VpcInfo[];
/** 是否开公网 */
EnableClientInternet?: boolean;
/** 限流客户端内网的网络信息 */
LimiterIntranetVpcInfos?: VpcInfo[];
/** 是否为主地域,仅在服务治理中心多地域有效 */
MainRegion?: boolean;
/** 该地域所在的EKS集群 */
EKSClusterID?: string;
}
/** 获取云原生api网关公网地址信息响应结果 */
declare interface DescribePublicAddressConfigResult {
/** 网关实例id */
GatewayId?: string;
/** 公网地址信息 */
ConfigList?: PublicAddressConfig[];
/** 总个数 */
TotalCount?: number;
}
/** 查询客户端公网信息 */
declare interface DescribePublicNetworkResult {
/** 网关实例ID */
GatewayId?: string;
/** 网关分组ID */
GroupId?: string;
/** 客户端公网信息 */
PublicNetwork?: CloudNativeAPIGatewayConfig;
}
/** 获取WAF保护域名列表 */
declare interface DescribeWafDomainsResult {
/** WAF防护域名列表 */
Domains?: string[] | null;
}
/** 获取WAF保护资源状态 */
declare interface DescribeWafProtectionResult {
/** 全局防护状态 */
GlobalStatus?: string;
/** 服务防护状态 */
ServicesStatus?: ServiceWafStatus[];
/** 路由防护状态 */
RouteStatus?: RouteWafStatus[];
/** 对象防护状态 */
ObjectStatus?: string;
}
/** 引擎的初始管理账号,当前仅支持Apollo引擎 */
declare interface EngineAdmin {
/** 控制台初始用户名 */
Name?: string;
/** 控制台初始密码 */
Password?: string;
/** 引擎接口的管理员 Token */
Token?: string;
}
/** 引擎地域配置详情 */
declare interface EngineRegionInfo {
/** 引擎节点所在地域 */
EngineRegion: string;
/** 此地域节点分配数量 */
Replica: number;
/** 集群网络信息 */
VpcInfos: VpcInfo[];
/** Polaris: 是否为主地域Zookeeper: 是否为Leader固定地域 */
MainRegion?: boolean;
/** 引擎规格ID */
SpecId?: string;
}
/** 多环境网络信息 */
declare interface EnvAddressInfo {
/** 环境名 */
EnvName?: string;
/** 是否开启config公网 */
EnableConfigInternet?: boolean;
/** config公网ip */
ConfigInternetServiceIp?: string;
/** config内网访问地址 */
ConfigIntranetAddress?: string;
/** 是否开启config内网clb */
EnableConfigIntranet?: boolean;
/** 客户端公网带宽 */
InternetBandWidth?: number;
/** 客户端公网CLB多可用区信息 */
CLBMultiRegion?: CLBMultiRegion;
}
/** 环境具体信息 */
declare interface EnvInfo {
/** 环境名称 */
EnvName: string;
/** 环境对应的网络信息 */
VpcInfos: 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;
}
/** 云原生网关限流插件外部redis配置 */
declare interface ExternalRedis {
/** redis ip */
RedisHost: string;
/** redis密码 */
RedisPassword: string;
/** redis端口 */
RedisPort: number;
/** 超时时间 ms */
RedisTimeout: number;
}
/** 查询过滤通用对象 */
declare interface Filter {
/** 过滤参数名 */
Name: string;
/** 过滤参数值 */
Values: string[];
}
/** 网关实例协议端口列表 */
declare interface GatewayInstanceSchemeAndPorts {
/** 端口协议,可选HTTP、HTTPS、TCP和UDP */
Scheme?: string;
/** 端口列表 */
PortList?: number[];
}
/** 轻量查询网关服务列表出参 */
declare interface GatewayServices {
/** 服务列表 */
ServiceList?: KongServiceLightPreview[];
/** 结果总数 */
TotalCount?: number;
}
/** 服务别名结构信息 */
declare interface GovernanceAlias {
/** 服务别名 */
Alias?: string;
/** 服务别名命名空间 */
AliasNamespace?: string;
/** 服务别名指向的服务名 */
Service?: string;
/** 服务别名指向的服务命名空间 */
Namespace?: string;
/** 服务别名的描述信息 */
Comment?: string;
/** 服务别名创建时间 */
CreateTime?: string;
/** 服务别名修改时间 */
ModifyTime?: string;
/** 服务别名ID */
Id?: string;
/** 该服务别名是否可以编辑 */
Editable?: boolean;
/** 元数据信息 */
Metadatas?: Metadata[] | null;
}
/** 治理中心实例信息。 */
declare interface GovernanceInstance {
/** 实例id。 */
Id?: string;
/** 实例所在服务名。 */
Service?: string;
/** 实例所在命名空间名。 */
Namespace?: string;
/** 实例ip地址。 */
Host?: string;
/** 实例端口信息。 */
Port?: number;
/** 通信协议。 */
Protocol?: string;
/** 版本信息。 */
Version?: string;
/** 负载均衡权重。 */
Weight?: number;
/** 是否开启健康检查。 */
EnableHealthCheck?: boolean;
/** 实例是否健康。 */
Healthy?: boolean;
/** 实例是否隔离。 */
Isolate?: boolean;
/** 实例创建时间。 */
CreateTime?: string;
/** 实例修改时间。 */
ModifyTime?: string;
/** 元数据数组。 */
Metadatas?: Metadata[];
/** 上报心跳间隔。 */
Ttl?: number;
/** 版本信息。 */
InstanceVersion?: string;
/** 状态信息 */
HealthStatus?: string;
/** 描述 */
Comment?: string;
}
/** 实例信息 */
declare interface GovernanceInstanceInput {
/** 实例所在服务名。 */
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;
}
/** 实例信息 */
declare 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?: Metadata[];
}
/** 服务契约接口定义 */
declare interface GovernanceInterfaceDescription {
/** 契约接口ID */
ID?: string;
/** 方法名称 */
Method?: string;
/** 路径/接口名称 */
Path?: string;
/** 内容 */
Content?: string;
/** 创建来源 */
Source?: string;
/** 信息摘要 */
Revision?: string;
/** 创建时间 */
CreateTime?: string;
/** 修改时间 */
ModifyTime?: string;
/** 接口名称 */
Name?: string;
}
/** 治理中心命名空间 */
declare interface GovernanceNamespace {
/** 命名空间名称。 */
Name?: string;
/** 命名空间描述信息。 */
Comment?: string;
/** 创建时间。 */
CreateTime?: string;
/** 修改时间。 */
ModifyTime?: string;
/** 命名空间下总服务数据量 */
TotalServiceCount?: number;
/** 命名空间下总健康实例数量 */
TotalHealthInstanceCount?: number;
/** 命名空间下总实例数量 */
TotalInstanceCount?: number;
/** 命名空间ID */
Id?: string;
/** 是否可以编辑 */
Editable?: boolean;
/** 可以操作此命名空间的用户ID列表 */
UserIds?: string[];
/** 可以操作此命名空间的用户组ID列表 */
GroupIds?: string[];
/** 移除可以操作此命名空间的用户ID列表 */
RemoveUserIds?: string[];
/** 移除可以操作此命名空间的用户组ID列表 */
RemoveGroupIds?: string[];
/** 该命名空间下的服务对哪些命名空间可见 */
ServiceExportTo?: string[];
/** 是否开启同步到全局注册中心 */
SyncToGlobalRegistry?: boolean;
/** 元数据 */
Metadatas?: Metadata[] | null;
}
/** 治理中心命名空间输入参数 */
declare interface GovernanceNamespaceInput {
/** 命名空间名。 */
Name: string;
/** 描述信息。 */
Comment?: string;
/** 新增的可以操作此命名空间的用户ID列表 */
UserIds?: string[];
/** 新增的可以操作此命名空间的用户组ID列表 */
GroupIds?: string[];
/** 移除可以操作此命名空间的用户ID列表 */
RemoveUserIds?: string[];
/** 移除可以操作此命名空间的用户组ID列表 */
RemoveGroupIds?: string[];
/** 该命名空间下的服务对哪些命名空间下可见,1、为空或者不填写,表示仅当前命名空间可见2、列表内容仅一个元素,且为字符 *,表示所有命名空间可见(包括新增)3、列表内容为部份命名空间名称,则只对这些命名空间下可见 */
ServiceExportTo?: string[];
/** 是否开启同步到全局注册中心 */
SyncToGlobalRegistry?: boolean;
}
/** 治理中心服务信息。 */
declare interface GovernanceService {
/** 服务名称。 */
Name?: string;
/** 命名空间名称。 */
Namespace?: string;
/** 元数据信息数组。 */
Metadatas?: Metadata[];
/** 描述信息。 */
Comment?: string;
/** 创建时间。 */
CreateTime?: string;
/** 修改时间。 */
ModifyTime?: string;
/** 服务所属部门。 */
Department?: string;
/** 服务所属业务。 */
Business?: string;
/** 健康服务实例数 */
HealthyInstanceCount?: number;
/** 服务实例总数 */
TotalInstanceCount?: number;
/** 服务ID */
Id?: string;
/** 是否可以编辑 */
Editable?: boolean;
/** 可以编辑该资源的用户ID */
UserIds?: string[];
/** 可以编辑该资源的用户组ID */
GroupIds?: string[];
/** 移除可以编辑该资源的用户ID */
RemoveUserIds?: string[];
/** 移除可以编辑该资源的用户组ID */
RemoveGroupIds?: string[];
/** 该服务对哪些命名空间可见 */
ExportTo?: string[];
/** 该服务信息摘要签名 */
Revision?: string;
/** 是否开启同步到全局注册中心 */
SyncToGlobalRegistry?: boolean;
}
/** 服务契约定义 */
declare interface GovernanceServiceContract {
/** 契约名称 */
Name: string;
/** 所属服务命名空间 */
Namespace: string;
/** 协议 */
Protocol: string;
/** 契约ID */
ID?: string;
/** 所属服务名称 */
Service?: string;
/** 版本 */
Version?: string;
/** 信息摘要 */
Revision?: string;
/** 额外内容描述 */
Content?: string;
/** 创建时间 */
CreateTime?: string;
/** 修改时间 */
ModifyTime?: string;
/** 契约接口列表 */
Interfaces?: GovernanceInterfaceDescription[];
/** 元数据 */
Metadatas?: Metadata[] | null;
}
/** 服务契约版本信息 */
declare interface GovernanceServiceContractVersion {
/** 契约版本 */
Version?: string;
/** 契约名称 */
Name?: string;
/** 唯一名称 */
Key?: string;
}
/** 治理中心服务入参 */
declare interface GovernanceServiceInput {
/** 服务名。 */
Name: string;
/** 服务所属命名空间。 */
Namespace: string;
/** 服务描述信息。 */
Comment?: string;
/** 服务元数据。 */
Metadatas?: Metadata[];
/** 服务所属部门。 */
Department?: string;
/** 服务所属业务。 */
Business?: string;
/** 被添加进来可以操作此命名空间的用户ID列表 */
UserIds?: string[];
/** 被添加进来可以操作此命名空间的用户组ID列表 */
GroupIds?: string[];
/** 从操作此命名空间的用户组ID列表被移除的ID列表 */
RemoveUserIds?: string[];
/** 从可以操作此命名空间的用户组ID列表中被移除的ID列表 */
RemoveGroupIds?: string[];
/** 该服务对哪些命名空间可见 */
ExportTo?: string[];
/** 是否开启同步到全局注册中心 */
SyncToGlobalRegistry?: boolean;
}
/** 实例监听端口信息 */
declare interface InstancePort {
/** 监听的 http 端口范围。 */
HttpPort?: string;
/** 监听的 https 端口范围。 */
HttpsPort?: string;
/** 监听的 tcp 端口范围。 */
TcpPort?: string;
/** 监听的 udp 端口范围。 */
UdpPort?: string;
}
/** 引擎实例的标签信息 */
declare interface InstanceTagInfo {
/** 标签键 */
TagKey?: string;
/** 标签值 */
TagValue?: string;
}
/** 公网负载均衡配置 */
declare 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;
}
/** 键值对 */
declare interface KVMapping {
/** key */
Key?: string;
/** value */
Value?: string;
}
/** 键值对 */
declare interface KVPair {
/** 键 */
Key?: string;
/** 值 */
Value?: string;
}
/** Key/Value结构 */
declare interface KeyValue {
/** 条件的Key */
Key?: string;
/** 条件的Value */
Value?: string;
}
/** Kong网关主动健康检查配置 */
declare interface KongActiveHealthCheck {
/** 主动健康检查健康探测间隔,单位:秒,0表示不开启 */
HealthyInterval?: number;
/** 主动健康检查异常探测间隔,单位:秒,0表示不开启 */
UnHealthyInterval?: number;
/** 在 GET HTTP 请求中使用的路径,以作为主动运行状况检查的探测器运行。默认: ”/”。 */
HttpPath?: string;
/** GET HTTP 请求的超时时间,单位:秒。默认 60。 */
Timeout?: number;
}
/** 云原生网关证书 */
declare interface KongCertificate {
/** 无 */
Cert?: KongCertificatesPreview;
}
/** kong证书列表 */
declare interface KongCertificatesList {
/** 证书列表总数 */
Total?: number;
/** 无 */
CertificatesList?: KongCertificatesPreview[] | null;
/** 证书列表总页数 */
Pages?: number | null;
}
/** 云原生网关证书预览信息 */
declare interface KongCertificatesPreview {
/** 证书名称 */
Name?: string;
/** Id */
Id?: string;
/** 绑定的域名 */
BindDomains?: string[];
/** 证书状态:expired(已过期) active(生效中) */
Status?: string;
/** 证书pem格式 */
Crt?: string;
/** 证书私钥 */
Key?: string;
/** 证书过期时间 */
ExpireTime?: string;
/** 证书上传时间 */
CreateTime?: string;
/** 证书签发时间 */
IssueTime?: string;
/** 证书来源:native(kong自定义证书) ssl(ssl平台证书) */
CertSource?: string;
/** ssl平台证书Id */
CertId?: string;
}
/** Kong网关被动健康检查配置 */
declare interface KongPassiveHealthCheck {
/** 后端target协议类型,被动健康检查支持http和tcp,主动健康检查支持http */
Type?: string;
}
/** 云原生网关路由信息 */
declare interface KongRoutePreview {
/** 服务ID */
ID: string;
/** 服务名字 */
Name?: string;
/** 无 */
Methods?: string[] | null;
/** 无 */
Paths?: string[] | null;
/** 无 */
Hosts?: string[] | null;
/** 无 */
Protocols?: string[];
/** 无 */
PreserveHost?: boolean;
/** 无 */
HttpsRedirectStatusCode?: number;
/** 无 */
StripPath?: boolean;
/** 无 */
CreatedTime?: string;
/** 是否开启了强制HTTPS */
ForceHttps?: boolean | null;
/** 服务名 */
ServiceName?: string;
/** 服务ID */
ServiceID?: string;
/** 目的端口 */
DestinationPorts?: number[];
/** 路由的Headers */
Headers?: KVMapping[];
/** 是否缓存请求body,默认true */
RequestBuffering?: boolean;
/** 是否缓存响应body,默认true */
ResponseBuffering?: boolean;
/** 正则优先级 */
RegexPriority?: number;
}
/** 云原生网关服务详细信息 */
declare interface KongServiceDetail {
/** 服务ID */
ID: string;
/** 服务名字 */
Name?: string;
/** 后端协议 */
Protocol?: string;
/** 后端路径 */
Path?: string | null;
/** 后端延时,单位ms */
Timeout?: number;
/** 重试次数 */
Retries?: number;
/** 标签 */
Tags?: string[] | null;
/** 后端配置 */
UpstreamInfo?: KongUpstreamInfo;
/** 后端类型 */
UpstreamType?: string;
/** 是否可编辑 */
Editable?: boolean;
/** 创建时间 */
CreatedTime?: string;
}
/** 云原生网关服务简洁预览信息 */
declare interface KongServiceLightPreview {
/** 服务ID */
ID?: string;
/** 服务名字 */
Name?: string;
/** 后端配置 */
UpstreamInfo?: KongUpstreamInfo;
/** 后端类型 */
UpstreamType?: string;
/** 创建时间 */
CreatedTime?: string;
/** 请求路径 */
Path?: string | null;
/** 后端协议 */
Protocol?: string;
/** 重试次数 */
Retries?: number;
/** 后端延时,单位ms */
Timeout?: number;
}
/** 云原生网关服务预览信息 */
declare interface KongServicePreview {
/** 服务ID */
ID: string;
/** 服务名字 */
Name?: string;
/** 标签 */
Tags?: string[];
/** 后端配置 */
UpstreamInfo?: KongUpstreamInfo;
/** 后端类型 */
UpstreamType?: string;
/** 创建时间 */
CreatedTime?: string;
/** 是否可编辑 */
Editable?: boolean;
/** 请求路径 */
Path?: string | null;
}
/** kong服务路由列表 */
declare interface KongServiceRouteList {
/** 无 */
RouteList?: KongRoutePreview[];
/** 总数 */
TotalCount?: number;
}
/** kong实例的服务列表 */
declare interface KongServices {
/** kong实例的服务列表 */
ServiceList?: KongServicePreview[];
/** 列表总数 */
TotalCount?: number;
}
/** Kong Upstream中的Target */
declare 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?: string[];
}
/** 服务的后端配置 */
declare interface KongUpstreamInfo {
/** IP或域名 */
Host?: string;
/** 端口 */
Port?: number;
/** 服务来源ID */
SourceID?: string;
/** 命名空间 */
Namespace?: string;
/** 服务(注册中心或Kubernetes中的服务)名字 */
ServiceName?: string;
/** 服务后端类型是IPList时提供 */
Targets?: KongTarget[] | null;
/** 服务来源类型 */
SourceType?: string;
/** SCF函数类型 */
ScfType?: string;
/** SCF函数命名空间 */
ScfNamespace?: string;
/** SCF函数名 */
ScfLambdaName?: string;
/** SCF函数版本 */
ScfLambdaQualifier?: string;
/** 冷启动时间,单位秒 */
SlowStart?: number;
/** 负载均衡算法,默认为 round-robin,还支持 least-connections,consisten_hashing */
Algorithm?: string;
/** CVM弹性伸缩组ID */
AutoScalingGroupID?: string;
/** CVM弹性伸缩组端口 */
AutoScalingCvmPort?: number;
/** CVM弹性伸缩组使用的CVM TAT命令状态 */
AutoScalingTatCmdStatus?: string;
/** CVM弹性伸缩组生命周期挂钩状态 */
AutoScalingHookStatus?: string;
/** 服务来源的名字 */
SourceName?: string;
/** 精确的服务来源类型,新建服务来源时候传入的类型 */
RealSourceType?: string;
/** upstream健康状态HEALTHY(健康), UNHEALTHY(异常), HEALTHCHECKS_OFF(未开启)和NONE(不支持健康检查) */
HealthStatus?: string;
/** 云函数是否开启CAM鉴权,不填时默认为开启(true) */
ScfCamAuthEnable?: boolean;
/** 云函数是否开启Base64编码,默认为false */
ScfIsBase64Encoded?: boolean;
/** 云函数是否开启响应集成,默认为false */
ScfIsIntegratedResponse?: boolean;
}
/** kong后端upstream列表 */
declare interface KongUpstreamList {
/** 无 */
UpstreamList?: KongUpstreamPreview[];
}
/** 云原生网关Upstream信息 */
declare interface KongUpstreamPreview {
/** 服务ID */
ID: string;
/** 服务名字 */
Name?: string;
/** 后端配置 */
Target?: KongTarget[];
}
/** 参数限流的规则 */
declare interface LimitRule {
/** 请求匹配条件 */
Filters?: RuleFilter[];
/** 参数限流依据组合 */
LimitBy?: KeyValue[];
/** 限流阈值 */
QpsThresholds?: QpsThreshold[];
/** 精确限流阈值 */
AccurateQpsThresholds?: AccurateQpsThreshold[];
}
/** 获取云原生API网关实例列表响应结果。 */
declare interface ListCloudNativeAPIGatewayResult {
/** 总数。 */
TotalCount: number;
/** 云原生API网关实例列表。 */
GatewayList: DescribeCloudNativeAPIGatewayResult[];
}
/** 获取云原生API网关实例策略绑定网关分组列表响应结果。 */
declare interface ListCloudNativeAPIGatewayStrategyBindingGroupInfoResult {
/** 数量 */
TotalCount: number;
/** 云原生API网关实例策略绑定网关分组列表 */
GroupInfos: CloudNativeAPIGatewayStrategyBindingGroupInfo[];
}
/** 获取云原生API网关实例策略响应结果。 */
declare interface ListCloudNativeAPIGatewayStrategyResult {
/** 总数。 */
TotalCount: number;
/** 云原生API网关实例策略列表。 */
StrategyList: CloudNativeAPIGatewayStrategy[];
}
/** 列表过滤条件,模糊匹配 */
declare interface ListFilter {
/** 过滤字段 */
Key?: string;
/** 过滤值 */
Value?: string;
}
/** 新增Location字段,展示zone/region/campus */
declare interface Location {
/** 大区 */
Region?: string;
/** 可用区 */
Zone?: string;
/** 机房 */
Campus?: string;
}
/** 元数据信息 */
declare interface Metadata {
/** 元数据键名。 */
Key: string;
/** 元数据键值。不填则默认为空字符串。 */
Value?: string;
}
/** Nacos副本信息 */
declare interface NacosReplica {
/** 名称 */
Name?: string;
/** 角色 */
Role?: string;
/** 状态 */
Status?: string;
/** 子网ID */
SubnetId?: string;
/** 可用区ID */
Zone?: string;
/** 可用区ID */
ZoneId?: string;
/** VPC ID */
VpcId?: string;
}
/** nacos服务端接口列表,用于云监控 */
declare interface NacosServerInterface {
/** 接口名 */
Interface?: string;
}
/** 云原生网关分组信息 */
declare interface NativeGatewayServerGroup {
/** 云原生网关分组唯一id */
GroupId?: string;
/** 分组名 */
Name?: string;
/** 描述信息 */
Description?: string;
/** 节点规格、节点数信息 */
NodeConfig?: CloudNativeAPIGatewayNodeConfig;
/** 网关分组状态。 */
Status?: string;
/** 创建时间 */
CreateTime?: string;
/** 是否是默认分组。0:否。1:是。 */
IsFirstGroup?: number;
/** 关联策略信息 */
BindingStrategy?: CloudNativeAPIGatewayStrategy;
/** 网关实例 id */
GatewayId?: string;
/** 带宽 */
InternetMaxBandwidthOut?: number;
/** 修改时间 */
ModifyTime?: string;
/** 子网id */
SubnetIds?: string;
/** 分组默认权重 */
DefaultWeight?: number;
/** 弹性节点 */
ElasticNumber?: number;
/** 是否支持TOA */
SupportTOA?: boolean;
/** 是否支持IPV6 */
SupportIPV6?: boolean;
}
/** 网关分组列表 */
declare interface NativeGatewayServerGroups {
/** 总数 */
TotalCount: number;
/** 分组信息数组。 */
GatewayGroupList: NativeGatewayServerGroup[];
}
/** 网关数据来源单个描述 */
declare interface NativeGatewayServiceSourceItem {
/** 网关实例ID */
GatewayID: string;
/** 服务来源ID */
SourceID: string;
/** 服务来源名称 */
SourceName: string;
/** 服务来源类型 */
SourceType: string;
/** 服务来源额外信息 */
SourceInfo: SourceInfo;
/** 创建时间 */
CreateTime: string;
/** 修改时间 */
ModifyTime: string;
}
/** 网络访问策略 */
declare interface NetworkAccessControl {
/** 访问模式:Whitelist|Blacklist */
Mode: string;
/** 白名单列表 */
CidrWhiteList?: string[];
/** 黑名单列表 */
CidrBlackList?: string[];
}
/** 北极星日志主题信息 */
declare interface PolarisCLSTopicInfo {
/** 日志集ID */
LogSetId?: string;
/** 日志集名称 */
LogSetName?: string;
/** 日志主题ID */
TopicId?: string;
/** 日志主题名称 */
TopicName?: string;
}
/** 查询Limiter的接入地址 */
declare interface PolarisLimiterAddress {
/** VPC接入IP列表 */
IntranetAddress?: string;
}
/** 公网地址信息 */
declare interface PublicAddressConfig {
/** 公网 ip */
Vip?: string;
/** 公网最大带宽 */
InternetMaxBandwidthOut?: number;
/** 公网所属分组 id */
GroupId?: string;
/** 公网所属分组名 */
GroupName?: string;
/** 公网负载均衡 id */
NetworkId?: string;
/** 公网负载均衡描述 */
Description?: string;
}
/** 云原生网关限流插件Qps阈值 */
declare interface QpsThreshold {
/** qps阈值控制维度,包含:second、minute、hour、day、month、year */
Unit: string;
/** 阈值 */
Max: number;
}
/** 配置发布版本信息 */
declare interface ReleaseVersion {
/** 配置发布的版本 */
Name?: string;
/** 是否生效 */
Active?: boolean;
/** 配置发布的ID */
Id?: string;
/** 配置发布的命名空间 */
Namespace?: string;
/** 配置发布的分组 */
Group?: string;
/** 配置发布的文件名 */
FileName?: string;
}
/** 路由 WAF 状态 */
declare interface RouteWafStatus {
/** 路由的名字 */
Name?: string;
/** 路由的 ID */
Id?: string;
/** 路由是否开启 WAF 防护 */
Status?: string;
/** 方法 */
Methods?: string[];
/** 路径 */
Paths?: string[];
/** 域名 */
Hosts?: string[];
/** 路由对应服务的名字 */
ServiceName?: string;
/** 路由对应服务的ID */
ServiceId?: string;
}
/** 限流规则的Filter */
declare interface RuleFilter {
/** 限流条件的Key */
Key?: string;
/** 限流条件的Values */
Values?: string[];
/** 操作符 */
Operator?: string;
/** header或query对应的name */
Name?: string;
}
/** 微服务注册引擎实例 */
declare interface SREInstance {
/** 实例ID */
InstanceId?: string;
/** 名称 */
Name?: string;
/** 版本号 */
Edition?: string;
/** 状态, 枚举值:creating/create_fail/running/updating/update_fail/restarting/restart_fail/destroying/destroy_fail */
Status?: string;
/** 规格ID */
SpecId?: string;
/** 副本数 */
Replica?: number;
/** 类型 */
Type?: string;
/** Vpc iD */
VpcId?: string;
/** 子网ID */
SubnetIds?: string[];
/** 是否开启持久化存储 */
EnableStorage?: boolean;
/** 数据存储方式 */
StorageType?: string;
/** 云硬盘容量 */
StorageCapacity?: number;
/** 计费方式 */
Paymode?: string;
/** EKS集群的ID */
EKSClusterID?: string;
/** 集群创建时间 */
CreateTime?: string;
/** 环境配置信息列表 */
EnvInfos?: EnvInfo[];
/** 引擎所在的区域 */
EngineRegion?: string;
/** 注册引擎是否开启公网 */
EnableInternet?: boolean;
/** 私有网络列表信息 */
VpcInfos?: VpcInfo[];
/** 服务治理相关信息列表 */
ServiceGovernanceInfos?: ServiceGovernanceInfo[];
/** 实例的标签信息 */
Tags?: KVPair[];
/** 引擎实例是否开启控制台公网访问地址 */
EnableConsoleInternet?: boolean;
/** 引擎实例是否开启控制台内网访问地址 */
EnableConsoleIntranet?: boolean;
/** 引擎实例是否展示参数配置页面 */
ConfigInfoVisible?: boolean;
/** 引擎实例控制台默认密码 */
ConsoleDefaultPwd?: string;
/** 交易付费类型,0后付费/1预付费 */
TradeType?: number;
/** 自动续费标记:0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费 */
AutoRenewFlag?: number;
/** 预付费到期时间 */
CurDeadline?: string;
/** 隔离开始时间 */
IsolateTime?: string;
/** 实例地域相关的描述信息 */
RegionInfos?: DescribeInstanceRegionInfo[];
/** 所在EKS环境,分为common和yunti */
EKSType?: string;
/** 引擎的产品版本 */
FeatureVersion?: string;
/** 引擎实例是否开启客户端内网访问地址 */
EnableClientIntranet?: boolean;
/** 存储额外配置选项 */
StorageOption?: StorageOption[];
/** Zookeeper的额外环境数据信息 */
ZookeeperRegionInfo?: ZookeeperRegionInfo;
/** 部署架构 */
DeployMode?: string;
/** 全局属性 */
GlobalType?: string;
/** 所属组类型 */
GroupType?: string;
/** 组id */
GroupId?: string[];
/** 是否为主地域 */
IsMainRegion?: boolean;
}
/** 服务治理相关的信息 */
declare interface ServiceGovernanceInfo {
/** 引擎所在的地域 */
EngineRegion: string;
/** 服务治理引擎绑定的kubernetes集群信息 */
BoundK8SInfos?: BoundK8SInfo[];
/** 服务治理引擎绑定的网络信息 */
VpcInfos?: VpcInfo[];
/** 当前实例鉴权是否开启 */
AuthOpen?: boolean;
/** 该实例支持的功能,鉴权就是 Auth */
Features?: string[];
/** 主账户名默认为 polaris,该值为主账户的默认密码 */
MainPassword?: string;
/** 服务治理pushgateway引擎绑定的网络信息 */
PgwVpcInfos?: VpcInfo[];
/** 服务治理限流server引擎绑定的网络信息 */
LimiterVpcInfos?: VpcInfo[];
/** 引擎关联CLS日志主题信息 */
CLSTopics?: PolarisCLSTopicInfo[];
/** 子用户密码 */
SubPassword?: string;
}
/** 服务的 WAF 状态 */
declare interface ServiceWafStatus {
/** 服务的名字 */
Name?: string;
/** 服务的 ID */
Id?: string;
/** 服务的类型 */
Type?: string;
/** 服务是否开启 WAF 防护 */
Status?: string;
}
/** 服务来源 */
declare interface SourceInfo {
/** 微服务引擎接入IP地址信息 */
Addresses?: string[];
/** 微服务引擎VPC信息 */
VpcInfo?: SourceInstanceVpcInfo;
/** 微服务引擎鉴权信息 */
Auth?: SourceInstanceAuth;
}
/** 实例鉴权信息 */
declare interface SourceInstanceAuth {
/** 用户名 */
Username?: string;
/** 账户密码 */
Password?: string;
/** 访问凭据 token */
AccessToken?: string;
}
/** 微服务引擎实例的VPC信息 */
declare interface SourceInstanceVpcInfo {
/** 微服务引擎VPC信息 */
VpcID?: string;
/** 微服务引擎子网信息 */
SubnetID?: string;
}
/** 存储的额外选项 */
declare interface StorageOption {
/** 存储对象,分为snap和txn两种 */
Name?: string;
/** 存储类型,分为三类CLOUD_PREMIUM/CLOUD_SSD/CLOUD_SSD_PLUS,分别对应高性能云硬盘、SSD云硬盘、增强型SSD云硬盘 */
Type?: string;
/** 存储容量,[50, 3200]的范围 */
Capacity?: number;
}
/** 更新云原生API网关响应结果。 */
declare interface UpdateCloudNativeAPIGatewayResult {
/** 云原生API网关ID。 */
GatewayId?: string;
/** 云原生网关状态。 */
Status?: string;
/** 任务ID */
TaskId?: string;
}
/** 云原生网关健康检查配置 */
declare interface UpstreamHealthCheckConfig {
/** 开启主动健康检查 */
EnableActiveHealthCheck?: boolean;
/** 主动健康检查配置 */
ActiveHealthCheck?: KongActiveHealthCheck;
/** 开启被动健康检查 */
EnablePassiveHealthCheck?: boolean;
/** 被动健康检查配置 */
PassiveHealthCheck?: KongPassiveHealthCheck;
/** 连续健康阈值,单位:次 */
Successes?: number;
/** 连续异常阈值,单位:次 */
Failures?: number;
/** 超时阈值,单位:次 */
Timeouts?: number;
/** 健康HTTP状态码 */
HealthyHttpStatuses?: number[];
/** 异常HTTP状态码 */
UnhealthyHttpStatuses?: number[];
/** 健康检查监控上报的数据屏蔽权重为0的节点 */
IgnoreZeroWeightNodes?: boolean | null;
/** 健康检查支持权重为0节点 */
ZeroWeightHeathCheck?: boolean;
}
/** 私有网络信息 */
declare interface VpcInfo {
/** Vpc Id */
VpcId: string;
/** 子网ID */
SubnetId: string;
/** 内网访问地址 */
IntranetAddress?: string;
/** 负载均衡均衡接入点子网ID */
LbSubnetId?: string;
}
/** Zookeeper的地域额外信息记录 */
declare interface ZookeeperRegionInfo {
/** 部署架构信息- SingleRegion: 普通单地域- MultiRegion: 普通多地域场景- MasterSlave: 两地域,主备地域场景 */
DeployMode?: string;
/** 主地域的额外信息 */
MainRegion?: ZookeeperRegionMyIdInfo;
/** 其他地域的额外信息 */
OtherRegions?: ZookeeperRegionMyIdInfo[];
}
/** Zookeeper的地域信息的 myid 信息记录 */
declare interface ZookeeperRegionMyIdInfo {
/** 地域信息 */
Region?: string;
/** myid 的起始号段 */
MyIdStart?: number;
/** myid 的结束号段 */
MyIdEnd?: number;
}
/** Zookeeper副本信息 */
declare interface ZookeeperReplica {
/** 名称 */
Name?: string;
/** 角色 */
Role?: string;
/** 状态 */
Status?: string;
/** 子网ID */
SubnetId?: string;
/** 可用区ID */
Zone?: string;
/** 可用区ID */
ZoneId?: string;
/** 别名 */
AliasName?: string;
/** VPC ID */
VpcId?: string;
}
/** Zookeeper服务端接口列表,用于云监控 */
declare interface ZookeeperServerInterface {
/** 接口名 */
Interface?: string;
}
declare interface BindAutoScalerResourceStrategyToGroupsRequest {
/** 网关实例ID */
GatewayId: string;
/** 策略ID */
StrategyId: string;
/** 网关分组ID列表 */
GroupIds: string[];
}
declare interface BindAutoScalerResourceStrategyToGroupsResponse {
/** 是否成功 */
Result?: boolean;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CloseWafProtectionRequest {
/** 网关ID */
GatewayId: string;
/** 防护资源的类型。- Global 实例- Service 服务- Route 路由- Object 对象 */
Type: string;
/** 当资源类型 Type 是 Service 或 Route 的时候,传入的服务或路由的列表 */
List?: string[];
}
declare interface CloseWafProtectionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAutoScalerResourceStrategyRequest {
/** 网关实例ID */
GatewayId: string;
/** 策略名称 */
StrategyName: string;
/** 策略描述 */
Description?: string;
/** 指标伸缩配置 */
Config?: CloudNativeAPIGatewayStrategyAutoScalerConfig;
/** 定时伸缩配置列表 */
CronScalerConfig?: CloudNativeAPIGatewayStrategyCronScalerConfig;
/** 最大节点数 */
MaxReplicas?: number;
/** 定时伸缩配置 */
CronConfig?: CloudNativeAPIGatewayStrategyCronScalerConfig;
}
declare interface CreateAutoScalerResourceStrategyResponse {
/** 是否成功 */
Result?: boolean;
/** 策略Id */
StrategyId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudNativeAPIGatewayCanaryRuleRequest {
/** 网关 ID */
GatewayId: string;
/** 服务 ID */
ServiceId: string;
/** 灰度规则配置 */
CanaryRule?: CloudNativeAPIGatewayCanaryRule;
/** 灰度规则配置列表,如果配置了此参数,将以此参数为准,忽略CanaryRule参数 */
CanaryRuleList?: CloudNativeAPIGatewayCanaryRule[];
}
declare interface CreateCloudNativeAPIGatewayCanaryRuleResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudNativeAPIGatewayCertificateRequest {
/** 网关ID */
GatewayId: string;
/** 绑定的域名 */
BindDomains: string[];
/** ssl平台证书 Id */
CertId: string;
/** 证书名称 */
Name?: string;
/** 证书私钥 */
Key?: string;
/** 证书pem格式 */
Crt?: string;
}
declare interface CreateCloudNativeAPIGatewayCertificateResponse {
/** 创建证书结果 */
Result?: CertificateInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudNativeAPIGatewayPublicNetworkRequest {
/** 云原生API网关实例ID。 */
GatewayId: string;
/** 分组id。 */
GroupId?: string;
/** 公网负载均衡配置。 */
InternetConfig?: InternetConfig;
}
declare interface CreateCloudNativeAPIGatewayPublicNetworkResponse {
/** 返回结果 */
Result?: CreatePublicNetworkResult;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudNativeAPIGatewayRequest {
/** 云原生API网关名字, 最多支持60个字符。 */
Name: string;
/** 云原生API网关类型, 目前只支持kong。 */
Type: string;
/** 云原生API网关版本。参考值:- 2.4.1- 2.5.1 */
GatewayVersion: string;
/** 云原生API网关节点配置。 */
NodeConfig: CloudNativeAPIGatewayNodeConfig;
/** 云原生API网关vpc配置。 */
VpcConfig: CloudNativeAPIGatewayVpcConfig;
/** 云原生API网关描述信息, 最多支持120个字符。 */
Description?: string;
/** 标签列表 */
Tags?: InstanceTagInfo[];
/** 是否开启 CLS 日志。默认值:fasle */
EnableCls?: boolean;
/** 产品版本。参考值:- TRIAL:开发版- STANDARD:标准版 (默认值)- PROFESSIONAL:专业版 */
FeatureVersion?: string;
/** 公网出流量带宽,[1,2048]Mbps */
InternetMaxBandwidthOut?: number;
/** 实例实际的地域信息,默认值:ap-guangzhou */
EngineRegion?: string;
/** ingress Class名称 */
IngressClassName?: string;
/** 付费类型。参考值:0:后付费(默认值)1:预付费(接口暂不支持创建预付费实例) */
TradeType?: number;
/** 公网相关配置 */
InternetConfig?: InternetConfig;
/** 关联的prometheus ID */
PromId?: string;
}
declare interface CreateCloudNativeAPIGatewayResponse {
/** 创建云原生API网关实例响应结果。 */
Result?: CreateCloudNativeAPIGatewayResult;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudNativeAPIGatewayRouteRateLimitRequest {
/** 网关ID */
GatewayId: string;
/** 路由id,或路由名称。不支持“未命名” */
Id: string;
/** 限流配置 */
LimitDetail: CloudNativeAPIGatewayRateLimitDetail;
}
declare interface CreateCloudNativeAPIGatewayRouteRateLimitResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudNativeAPIGatewayRouteRequest {
/** 网关ID */
GatewayId: string;
/** 所属服务的ID */
ServiceID: string;
/** 路由的名字,实例级别唯一,可以不提供 */
RouteName?: string;
/** 路由的方法,其中方法可选值:- GET- POST- DELETE- PUT- OPTIONS- PATCH- HEAD- ANY- TRACE- COPY- MOVE- PROPFIND- PROPPATCH- MKCOL- LOCK- UNLOCK */
Methods?: string[];
/** 路由的域名 */
Hosts?: string[];
/** 路由的路径 */
Paths?: string[];
/** 路由的协议,可选- https- http */
Protocols?: string[];
/** 转发到后端时是否保留Host */
PreserveHost?: boolean;
/** https重定向状态码 */
HttpsRedirectStatusCode?: number;
/** 转发到后端时是否StripPath */
StripPath?: boolean;
/** 是否开启强制HTTPS */
ForceHttps?: boolean;
/** 四层匹配的目的端口 */
DestinationPorts?: number[];
/** 路由的Headers */
Headers?: KVMapping[];
/** 是否缓存请求body,默认true */
RequestBuffering?: boolean;
/** 是否缓存响应body,默认true */
ResponseBuffering?: boolean;
/** 正则优先级 */
RegexPriority?: number;
}
declare interface CreateCloudNativeAPIGatewayRouteResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudNativeAPIGatewayServiceRateLimitRequest {
/** 网关ID */
GatewayId: string;
/** 服务名称,或服务ID */
Name: string;
/** 限流配置 */
LimitDetail: CloudNativeAPIGatewayRateLimitDetail;
}
declare interface CreateCloudNativeAPIGatewayServiceRateLimitResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare 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;
}
declare interface CreateCloudNativeAPIGatewayServiceResponse {
/** 网关服务创建结果 */
Result?: CreateGatewayServiceResult;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateConfigFileGroupRequest {
/** tse 实例 id */
InstanceId: string;
/** 配置文件组实体 */
ConfigFileGroup: ConfigFileGroup;
}
declare interface CreateConfigFileGroupResponse {
/** 是否创建成功 */
Result?: boolean;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateConfigFile