tencentcloud-sdk-nodejs

/** * ip策略绑定api详情 */ export interface IPStrategyApiStatus { /** * 环境绑定API数量。注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * 环境绑定API详情。注意：此字段可能返回 null，表示取不到有效值。 */ ApiIdStatusSet: Array<IPStrategyApi>; } /** * UnBindSubDomain返回参数结构体 */ export interface UnBindSubDomainResponse { /** * 解绑自定义域名操作是否成功。 */ Result?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 后端通道详细信息 */ export interface UpstreamInfo { /** * 后端通道唯一ID */ UpstreamId: string; /** * 后端通道名字 */ UpstreamName: string; /** * 后端通道描述 */ UpstreamDescription: string; /** * 后端协议，取值范围：HTTP, HTTPS */ Scheme: string; /** * 负载均衡算法，取值范围：ROUND_ROBIN */ Algorithm: string; /** * VPC唯一ID */ UniqVpcId: string; /** * 请求重试次数 */ Retries: number; /** * 后端节点 */ Nodes: Array<UpstreamNode>; /** * 创建时间 */ CreatedTime: string; /** * 标签注意：此字段可能返回 null，表示取不到有效值。 */ Tags: Array<Tag>; /** * 健康检查配置注意：此字段可能返回 null，表示取不到有效值。 */ HealthChecker: UpstreamHealthChecker; /** * 后端的类型，取值范围：IP_PORT, K8S */ UpstreamType: string; /** * K8S容器服务配置注意：此字段可能返回 null，表示取不到有效值。 */ K8sServices: Array<K8sService>; /** * 网关转发给后端的Host请求头注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamHost: string; } /** * UpdateApiKey请求参数结构体 */ export interface UpdateApiKeyRequest { /** * 待更换的密钥 ID。 */ AccessKeyId: string; /** * 待更换的密钥 Key，更新自定义密钥时，该字段为必传。长度10 - 50字符，包括字母、数字、英文下划线。 */ AccessKeySecret?: string; } /** * 展示服务列表用 */ export interface Service { /** * 内网访问https端口。注意：此字段可能返回 null，表示取不到有效值。 */ InnerHttpsPort: number; /** * 用户自定义的服务描述。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceDesc: string; /** * 服务的前端请求类型。如http、https 或者 http&https。注意：此字段可能返回 null，表示取不到有效值。 */ Protocol: string; /** * 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ ModifiedTime: string; /** * 服务支持的网络类型。注意：此字段可能返回 null，表示取不到有效值。 */ NetTypes: Array<string>; /** * 独占集群名称。注意：此字段可能返回 null，表示取不到有效值。 */ ExclusiveSetName: string; /** * 服务唯一 ID。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceId: string; /** * IP版本。注意：此字段可能返回 null，表示取不到有效值。 */ IpVersion: string; /** * 已经发布的环境列表。如test、prepub、release。注意：此字段可能返回 null，表示取不到有效值。 */ AvailableEnvironments: Array<string>; /** * 用户自定义的服务名称。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceName: string; /** * 系统为该服务分配的外网域名。注意：此字段可能返回 null，表示取不到有效值。 */ OuterSubDomain: string; /** * 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ CreatedTime: string; /** * 内网访问http端口。注意：此字段可能返回 null，表示取不到有效值。 */ InnerHttpPort: number; /** * 系统为该服务自动分配的内网域名。注意：此字段可能返回 null，表示取不到有效值。 */ InnerSubDomain: string; /** * 服务的计费状态。注意：此字段可能返回 null，表示取不到有效值。 */ TradeIsolateStatus: number; /** * 服务绑定的标签注意：此字段可能返回 null，表示取不到有效值。 */ Tags: Array<Tag>; /** * 独享实例注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: string; /** * 集群类型注意：此字段可能返回 null，表示取不到有效值。 */ SetType: string; /** * 服务部署的集群类型注意：此字段可能返回 null，表示取不到有效值。 */ DeploymentType: string; } /** * DeleteAPIDoc请求参数结构体 */ export interface DeleteAPIDocRequest { /** * API文档ID */ ApiDocId: string; } /** * 已绑定的插件信息。 */ export interface AttachedPluginInfo { /** * 插件ID。 */ PluginId: string; /** * 环境信息。 */ Environment: string; /** * 绑定时间。 */ AttachedTime: string; /** * 插件名称。 */ PluginName: string; /** * 插件类型。 */ PluginType: string; /** * 插件描述。 */ Description: string; /** * 插件定义语句。 */ PluginData: string; } /** * api绑定使用计划列表 */ export interface ApiUsagePlanSet { /** * API 绑定的使用计划总数。注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * API 绑定使用计划列表。注意：此字段可能返回 null，表示取不到有效值。 */ ApiUsagePlanList: Array<ApiUsagePlan>; } /** * DescribeAPIDocDetail请求参数结构体 */ export interface DescribeAPIDocDetailRequest { /** * API文档ID */ ApiDocId: string; } /** * 创建api返回 */ export interface CreateApiResultInfo { /** * api id 注意：此字段可能返回 null，表示取不到有效值。 */ ApiId: string; /** * 路径注意：此字段可能返回 null，表示取不到有效值。 */ Path: string; /** * 请求方法注意：此字段可能返回 null，表示取不到有效值。 */ Method: string; /** * 创建时间注意：此字段可能返回 null，表示取不到有效值。 */ CreatedTime: string; } /** * ModifyAPIDoc返回参数结构体 */ export interface ModifyAPIDocResponse { /** * API文档基本信息 */ Result?: APIDoc; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 插件绑定的API列表 */ export interface AttachedApiSummary { /** * 插件绑定的API数量。 */ TotalCount: number; /** * 插件绑定的API信息。 */ AttachedApis: Array<AttachedApiInfo>; } /** * DescribeUsagePlan请求参数结构体 */ export interface DescribeUsagePlanRequest { /** * 待查询的使用计划唯一 ID。 */ UsagePlanId: string; } /** * DeleteUsagePlan返回参数结构体 */ export interface DeleteUsagePlanResponse { /** * 删除操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ImportOpenApi返回参数结构体 */ export interface ImportOpenApiResponse { /** * 导入OpenApi返回参数。 */ Result: CreateApiRspSet; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisableApiKey返回参数结构体 */ export interface DisableApiKeyResponse { /** * 禁用密钥操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeApi返回参数结构体 */ export interface DescribeApiResponse { /** * API 详情。 */ Result: ApiInfo; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeServiceForApiApp请求参数结构体 */ export interface DescribeServiceForApiAppRequest { /** * 待查询的服务唯一 ID。 */ ServiceId: string; /** * 服务所属的地域 */ ApiRegion: string; } /** * UnReleaseService请求参数结构体 */ export interface UnReleaseServiceRequest { /** * 待下线服务的唯一 ID。 */ ServiceId: string; /** * 待下线的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。 */ EnvironmentName: string; /** * 保留字段，待下线的API列表。 */ ApiIds?: Array<string>; } /** * DescribeExclusiveInstancesStatus返回参数结构体 */ export interface DescribeExclusiveInstancesStatusResponse { /** * 独享实例列表查询结果 */ Result?: InstanceSummary; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySubDomain请求参数结构体 */ export interface ModifySubDomainRequest { /** * 服务唯一 ID。 */ ServiceId: string; /** * 待修改路径映射的自定义的域名。 */ SubDomain: string; /** * 是否修改为使用默认路径映射。为 true，表示使用默认路径映射，为 false，表示使用自定义路径映射。 */ IsDefaultMapping: boolean; /** * 证书 ID，协议包含 HTTPS 的时候要传该字段。 */ CertificateId?: string; /** * 修改后的自定义域名协议类型。（http，https 或 http&https) */ Protocol?: string; /** * 修改后的路径映射列表。 */ PathMappingSet?: Array<PathMapping>; /** * 网络类型（'INNER' 或 'OUTER'） */ NetType?: string; /** * 是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。 */ IsForcedHttps?: boolean; } /** * DescribeApiAppsStatus请求参数结构体 */ export interface DescribeApiAppsStatusRequest { /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 过滤条件。支持ApiAppId、ApiAppName、KeyWord（可以匹配name或者ID）。 */ Filters?: Array<Filter>; } /** * DescribeServiceUsagePlan请求参数结构体 */ export interface DescribeServiceUsagePlanRequest { /** * 待查询的服务唯一 ID。 */ ServiceId: string; /** * 返回数量，默认为20，最大值为100。 */ Limit?: number; /** * 偏移量，默认为0。 */ Offset?: number; } /** * DescribeServiceEnvironmentList返回参数结构体 */ export interface DescribeServiceEnvironmentListResponse { /** * 服务绑定环境详情。注意：此字段可能返回 null，表示取不到有效值。 */ Result: ServiceEnvironmentSet; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeApiAppBindApisStatus请求参数结构体 */ export interface DescribeApiAppBindApisStatusRequest { /** * 应用ID */ ApiAppId: string; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 过滤条件。支持ApiId、ApiName、ServiceId、Environment 、KeyWord（可以匹配name或者ID）。 */ Filters?: Array<Filter>; } /** * ModifyApi返回参数结构体 */ export interface ModifyApiResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ServiceParameter */ export interface DescribeApiResultServiceParametersInfo { /** * API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * API 的后端服务参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。注意：此字段可能返回 null，表示取不到有效值。 */ Position?: string; /** * API 的后端服务参数对应的前端参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ RelevantRequestParameterPosition?: string; /** * API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ RelevantRequestParameterName?: string; /** * API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ DefaultValue?: string; /** * API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ RelevantRequestParameterDesc?: string; } /** * CreateApiRsp 返回加TotalCount */ export interface CreateApiRspSet { /** * 个数 */ TotalCount: number; /** * 返回的数组 */ ApiSet: Array<CreateApiRsp>; } /** * 展示api信息 */ export interface ApiInfo { /** * API 所在的服务唯一 ID。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceId?: string; /** * API 所在的服务的名称。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceName?: string; /** * API 所在的服务的描述。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceDesc?: string; /** * API 接口唯一 ID。注意：此字段可能返回 null，表示取不到有效值。 */ ApiId?: string; /** * API 接口的描述。注意：此字段可能返回 null，表示取不到有效值。 */ ApiDesc?: string; /** * 创建时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ CreatedTime?: string; /** * 最后修改时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ ModifiedTime?: string; /** * API 接口的名称。注意：此字段可能返回 null，表示取不到有效值。 */ ApiName?: string; /** * API 类型。可取值为NORMAL（普通API）、TSF（微服务API）。注意：此字段可能返回 null，表示取不到有效值。 */ ApiType?: string; /** * API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。注意：此字段可能返回 null，表示取不到有效值。 */ Protocol?: string; /** * API 鉴权类型。可取值为 SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。注意：此字段可能返回 null，表示取不到有效值。 */ AuthType?: string; /** * OAUTH API的类型。可取值为NORMAL（业务API）、OAUTH（授权API）。注意：此字段可能返回 null，表示取不到有效值。 */ ApiBusinessType?: string; /** * OAUTH 业务API 关联的授权API 唯一 ID。注意：此字段可能返回 null，表示取不到有效值。 */ AuthRelationApiId?: string; /** * OAUTH配置。注意：此字段可能返回 null，表示取不到有效值。 */ OauthConfig?: OauthConfig; /** * 是否购买后调试（云市场预留参数）。注意：此字段可能返回 null，表示取不到有效值。 */ IsDebugAfterCharge?: boolean; /** * 请求的前端配置。注意：此字段可能返回 null，表示取不到有效值。 */ RequestConfig?: RequestConfig; /** * 返回类型。注意：此字段可能返回 null，表示取不到有效值。 */ ResponseType?: string; /** * 自定义响应配置成功响应示例。注意：此字段可能返回 null，表示取不到有效值。 */ ResponseSuccessExample?: string; /** * 自定义响应配置失败响应示例。注意：此字段可能返回 null，表示取不到有效值。 */ ResponseFailExample?: string; /** * 用户自定义错误码配置。注意：此字段可能返回 null，表示取不到有效值。 */ ResponseErrorCodes?: Array<ErrorCodes>; /** * 前端请求参数。注意：此字段可能返回 null，表示取不到有效值。 */ RequestParameters?: Array<ReqParameter>; /** * API 的后端服务超时时间，单位是秒。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceTimeout?: number; /** * API 的后端服务类型。可取值为 HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceType?: string; /** * API 的后端服务配置。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceConfig?: ServiceConfig; /** * API的后端服务参数。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceParameters?: Array<DescribeApiResultServiceParametersInfo>; /** * 常量参数。注意：此字段可能返回 null，表示取不到有效值。 */ ConstantParameters?: Array<ConstantParameter>; /** * API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceMockReturnMessage?: string; /** * scf 函数名称。当后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceScfFunctionName?: string; /** * scf 函数命名空间。当后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceScfFunctionNamespace?: string; /** * scf函数版本。当后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceScfFunctionQualifier?: string; /** * 是否开启集成响应。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceScfIsIntegratedResponse?: boolean; /** * scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketRegisterFunctionName?: string; /** * scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketRegisterFunctionNamespace?: string; /** * scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketRegisterFunctionQualifier?: string; /** * scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketCleanupFunctionName?: string; /** * scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketCleanupFunctionNamespace?: string; /** * scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketCleanupFunctionQualifier?: string; /** * WEBSOCKET 回推地址。注意：此字段可能返回 null，表示取不到有效值。 */ InternalDomain?: string; /** * scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketTransportFunctionName?: string; /** * scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketTransportFunctionNamespace?: string; /** * scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceWebsocketTransportFunctionQualifier?: string; /** * API绑定微服务列表。注意：此字段可能返回 null，表示取不到有效值。 */ MicroServices?: Array<MicroService>; /** * 微服务信息详情。注意：此字段可能返回 null，表示取不到有效值。 */ MicroServicesInfo?: Array<number | bigint>; /** * 微服务的负载均衡配置。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceTsfLoadBalanceConf?: TsfLoadBalanceConfResp; /** * 微服务的健康检查配置。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceTsfHealthCheckConf?: HealthCheckConf; /** * 是否开启跨域。注意：此字段可能返回 null，表示取不到有效值。 */ EnableCORS?: boolean; /** * API绑定的tag信息。注意：此字段可能返回 null，表示取不到有效值。 */ Tags?: Array<Tag>; /** * API已发布的环境信息。注意：此字段可能返回 null，表示取不到有效值。 */ Environments?: Array<string>; /** * 是否开启Base64编码，只有后端为scf时才会生效。注意：此字段可能返回 null，表示取不到有效值。 */ IsBase64Encoded?: boolean; /** * 是否开启Base64编码的header触发，只有后端为scf时才会生效。注意：此字段可能返回 null，表示取不到有效值。 */ IsBase64Trigger?: boolean; /** * Header触发规则，总规则数量不超过10。注意：此字段可能返回 null，表示取不到有效值。 */ Base64EncodedTriggerRules?: Array<Base64EncodedTriggerRule>; /** * 是否开启SCF Event异步调用。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceScfEventIsAsyncCall?: boolean; } /** * tsf serverless入参 */ export interface TargetServicesReq { /** * vm ip */ VmIp: string; /** * vpc id */ VpcId: string; /** * vm port */ VmPort: number; /** * cvm所在宿主机ip */ HostIp: string; /** * docker ip */ DockerIp?: string; } /** * DescribeUsagePlansStatus请求参数结构体 */ export interface DescribeUsagePlansStatusRequest { /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 使用计划过滤条件。支持UsagePlanId、UsagePlanName、NotServiceId、NotApiId、Environment。 */ Filters?: Array<Filter>; } /** * TsfLoadBalanceConf 出参使用 */ export interface TsfLoadBalanceConfResp { /** * 是否开启负载均衡。注意：此字段可能返回 null，表示取不到有效值。 */ IsLoadBalance?: boolean; /** * 负载均衡方式。注意：此字段可能返回 null，表示取不到有效值。 */ Method?: string; /** * 是否开启会话保持。注意：此字段可能返回 null，表示取不到有效值。 */ SessionStickRequired?: boolean; /** * 会话保持超时时间。注意：此字段可能返回 null，表示取不到有效值。 */ SessionStickTimeout?: number; } /** * CreateIPStrategy请求参数结构体 */ export interface CreateIPStrategyRequest { /** * 服务的唯一ID。 */ ServiceId: string; /** * 用户自定义的策略名称。 */ StrategyName: string; /** * 策略类型。支持WHITE（白名单）和BLACK（黑名单）。 */ StrategyType: string; /** * 策略详情，多个ip 使用\n 分隔符分开。 */ StrategyData: string; } /** * ip策略 */ export interface IPStrategy { /** * 策略唯一ID。注意：此字段可能返回 null，表示取不到有效值。 */ StrategyId: string; /** * 用户自定义策略名称。注意：此字段可能返回 null，表示取不到有效值。 */ StrategyName: string; /** * 策略类型。支持WHITE（白名单）和BLACK（黑名单）。注意：此字段可能返回 null，表示取不到有效值。 */ StrategyType: string; /** * IP列表。注意：此字段可能返回 null，表示取不到有效值。 */ StrategyData: string; /** * 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ CreatedTime: string; /** * 修改时间。注意：此字段可能返回 null，表示取不到有效值。 */ ModifiedTime: string; /** * 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceId: string; /** * 策略绑定的API数量。注意：此字段可能返回 null，表示取不到有效值。 */ BindApiTotalCount: number; /** * 绑定的API详情。注意：此字段可能返回 null，表示取不到有效值。 */ BindApis: Array<DesApisStatus>; } /** * DescribeUsagePlansStatus返回参数结构体 */ export interface DescribeUsagePlansStatusResponse { /** * 使用计划列表。注意：此字段可能返回 null，表示取不到有效值。 */ Result: UsagePlansStatus; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 专享网络配置 */ export interface InstanceNetworkConfig { /** * 公网带宽 */ InternetMaxBandwidthOut: number; } /** * 健康检查配置，包括TsfHealthCheckConf和TargetServicesHealthCheckConf */ export interface HealthCheckConf { /** * 是否开启健康检查。注意：此字段可能返回 null，表示取不到有效值。 */ IsHealthCheck?: boolean; /** * 健康检查阈值。注意：此字段可能返回 null，表示取不到有效值。 */ RequestVolumeThreshold?: number; /** * 窗口大小。注意：此字段可能返回 null，表示取不到有效值。 */ SleepWindowInMilliseconds?: number; /** * 阈值百分比。注意：此字段可能返回 null，表示取不到有效值。 */ ErrorThresholdPercentage?: number; } /** * DeleteUpstream请求参数结构体 */ export interface DeleteUpstreamRequest { /** * 待删除的后端通道ID */ UpstreamId: string; } /** * API网关插件详情。 */ export interface Plugin { /** * 插件ID。 */ PluginId: string; /** * 插件名称。 */ PluginName: string; /** * 插件类型。 */ PluginType: string; /** * 插件定义语句。 */ PluginData: string; /** * 插件描述。注意：此字段可能返回 null，表示取不到有效值。 */ Description: string; /** * 插件创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime: string; /** * 插件修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime: string; /** * 插件绑定的API总数。注意：此字段可能返回 null，表示取不到有效值。 */ AttachedApiTotalCount: number; /** * 插件绑定的API信息。注意：此字段可能返回 null，表示取不到有效值。 */ AttachedApis: Array<AttachedApiInfo>; } /** * UnbindApiApp返回参数结构体 */ export interface UnbindApiAppResponse { /** * 解除绑定操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUpstream请求参数结构体 */ export interface ModifyUpstreamRequest { /** * 后端通道唯一ID */ UpstreamId: string; /** * 后端通道名字 */ UpstreamName?: string; /** * 后端通道描述 */ UpstreamDescription?: string; /** * 后端协议，取值范围：HTTP, HTTPS */ Scheme?: string; /** * 后端访问类型，取值范围：IP_PORT, K8S */ UpstreamType?: string; /** * 负载均衡算法，取值范围：ROUND_ROBIN */ Algorithm?: string; /** * VPC唯一ID */ UniqVpcId?: string; /** * 请求重试次数，默认3次 */ Retries?: number; /** * 网关转发到后端的 Host 请求头 */ UpstreamHost?: string; /** * 后端节点列表 */ Nodes?: Array<UpstreamNode>; /** * 健康检查配置，目前只支持VPC通道 */ HealthChecker?: UpstreamHealthChecker; /** * 容器服务配置 */ K8sService?: Array<K8sService>; } /** * DescribeApiUsagePlan返回参数结构体 */ export interface DescribeApiUsagePlanResponse { /** * api绑定使用计划列表。注意：此字段可能返回 null，表示取不到有效值。 */ Result: ApiUsagePlanSet; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteIPStrategy请求参数结构体 */ export interface DeleteIPStrategyRequest { /** * 待删除的IP策略所属的服务唯一ID。 */ ServiceId: string; /** * 待删除的IP策略唯一ID。 */ StrategyId: string; } /** * DescribeApiApp请求参数结构体 */ export interface DescribeApiAppRequest { /** * 应用ID。 */ ApiAppId: string; } /** * DescribePlugin返回参数结构体 */ export interface DescribePluginResponse { /** * 插件详情。 */ Result: Plugin; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUpstreamBindApis请求参数结构体 */ export interface DescribeUpstreamBindApisRequest { /** * 分页大小 */ Limit: number; /** * 分页起始位置 */ Offset: number; /** * 后端通道ID */ UpstreamId: string; /** * ServiceId和ApiId过滤查询 */ Filters?: Array<Filter>; } /** * DescribePluginsByApi返回参数结构体 */ export interface DescribePluginsByApiResponse { /** * 插件可绑定的API列表信息。 */ Result: AttachedPluginSummary; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeExclusiveInstances返回参数结构体 */ export interface DescribeExclusiveInstancesResponse { /** * 独享实例列表查询结果 */ Result?: DescribeExclusiveInstancesResult; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * k8s 服务的配置 */ export interface K8sService { /** * 权重 */ Weight: number; /** * k8s集群ID */ ClusterId: string; /** * 容器命名空间 */ Namespace: string; /** * 容器服务的名字 */ ServiceName: string; /** * 服务的端口 */ Port: number; /** * 额外选择的Pod的Label */ ExtraLabels: Array<K8sLabel>; /** * 自定义的服务名字，可选 */ Name?: string; } /** * DeleteUsagePlan请求参数结构体 */ export interface DeleteUsagePlanRequest { /** * 待删除的使用计划唯一 ID。 */ UsagePlanId: string; } /** * DeleteService请求参数结构体 */ export interface DeleteServiceRequest { /** * 待删除服务的唯一 ID。 */ ServiceId: string; /** * 跳过删除前置条件校验（仅支持独享实例上的服务） */ SkipVerification?: number; } /** * DescribeApiEnvironmentStrategy请求参数结构体 */ export interface DescribeApiEnvironmentStrategyRequest { /** * API所属服务唯一ID。 */ ServiceId: string; /** * 环境列表。 */ EnvironmentNames?: Array<string>; /** * API唯一ID。 */ ApiId?: string; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; } /** * 后端通道主动健康检查的请求头配置 */ export declare type UpstreamHealthCheckerReqHeaders = null; /** * 服务环境策略 */ export interface ServiceEnvironmentStrategy { /** * 环境名。 */ EnvironmentName: string; /** * 访问服务对应环境的url。 */ Url: string; /** * 发布状态。 */ Status: number; /** * 发布的版本号。注意：此字段可能返回 null，表示取不到有效值。 */ VersionName: string; /** * 限流值。 */ Strategy: number; /** * 最大限流值注意：此字段可能返回 null，表示取不到有效值。 */ MaxStrategy: number; } /** * DescribeServiceForApiApp返回参数结构体 */ export interface DescribeServiceForApiAppResponse { /** * 服务唯一ID。 */ ServiceId?: string; /** * 服务环境列表。注意：此字段可能返回 null，表示取不到有效值。 */ AvailableEnvironments?: Array<string>; /** * 服务名称。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceName?: string; /** * 服务描述。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceDesc?: string; /** * 服务支持协议，可选值为http、https、http&https。 */ Protocol?: string; /** * 服务创建时间。注意：此字段可能返回 null，表示取不到有效值。 */ CreatedTime?: string; /** * 服务修改时间。注意：此字段可能返回 null，表示取不到有效值。 */ ModifiedTime?: string; /** * 网络类型列表，INNER为内网访问，OUTER为外网访问。 */ NetTypes?: Array<string>; /** * 内网访问子域名。 */ InternalSubDomain?: string; /** * 外网访问子域名。 */ OuterSubDomain?: string; /** * 内网访问http服务端口号。 */ InnerHttpPort?: number; /** * 内网访问https端口号。 */ InnerHttpsPort?: number; /** * API总数。注意：此字段可能返回 null，表示取不到有效值。 */ ApiTotalCount?: number; /** * API列表。注意：此字段可能返回 null，表示取不到有效值。 */ ApiIdStatusSet?: Array<ApiIdStatus>; /** * 使用计划总数量。注意：此字段可能返回 null，表示取不到有效值。 */ UsagePlanTotalCount?: number; /** * 使用计划数组。注意：此字段可能返回 null，表示取不到有效值。 */ UsagePlanList?: Array<UsagePlan>; /** * IP版本。注意：此字段可能返回 null，表示取不到有效值。 */ IpVersion?: string; /** * 此服务的用户类型。注意：此字段可能返回 null，表示取不到有效值。 */ UserType?: string; /** * 预留字段。注意：此字段可能返回 null，表示取不到有效值。 */ SetId?: number; /** * 服务绑定的标签。注意：此字段可能返回 null，表示取不到有效值。 */ Tags?: Array<Tag>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ServiceConfig配置 */ export interface ServiceConfig { /** * 后端类型。启用vpc时生效，目前支持的类型为clb, cvm和upstream */ Product?: string; /** * vpc 的唯一ID。 */ UniqVpcId?: string; /** * API 的后端服务url。如果ServiceType是HTTP，则此参数必传。 */ Url?: string; /** * API 的后端服务路径，如 /path。如果 ServiceType 是 HTTP，则此参数必传。前后端路径可不同。 */ Path?: string; /** * API的后端服务请求方法，如 GET。如果 ServiceType 是 HTTP，则此参数必传。前后端方法可不同。 */ Method?: string; /** * 当绑定vpc通道才需要注意：此字段可能返回 null，表示取不到有效值。 */ UpstreamId?: string; /** * API后端COS配置。如果 ServiceType 是 COS，则此参数必传。注意：此字段可能返回 null，表示取不到有效值。 */ CosConfig?: CosConfig; } /** * DeleteApiApp返回参数结构体 */ export interface DeleteApiAppResponse { /** * 删除操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeService返回参数结构体 */ export interface DescribeServiceResponse { /** * 服务唯一ID。 */ ServiceId?: string; /** * 服务环境列表。 */ AvailableEnvironments?: Array<string>; /** * 服务名称。 */ ServiceName?: string; /** * 服务描述。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceDesc?: string; /** * 服务支持协议，可选值为http、https、http&https。 */ Protocol?: string; /** * 服务创建时间。 */ CreatedTime?: string; /** * 服务修改时间。 */ ModifiedTime?: string; /** * 网络类型列表，INNER为内网访问，OUTER为外网访问。 */ NetTypes?: Array<string>; /** * 内网访问子域名。 */ InternalSubDomain?: string; /** * 外网访问子域名。 */ OuterSubDomain?: string; /** * 内网访问http服务端口号。 */ InnerHttpPort?: number; /** * 内网访问https端口号。 */ InnerHttpsPort?: number; /** * API总数。 */ ApiTotalCount?: number; /** * API列表。注意：此字段可能返回 null，表示取不到有效值。 */ ApiIdStatusSet?: Array<ApiIdStatus>; /** * 使用计划总数量。 */ UsagePlanTotalCount?: number; /** * 使用计划数组。注意：此字段可能返回 null，表示取不到有效值。 */ UsagePlanList?: Array<UsagePlan>; /** * IP版本。注意：此字段可能返回 null，表示取不到有效值。 */ IpVersion?: string; /** * 此服务的用户类型。注意：此字段可能返回 null，表示取不到有效值。 */ UserType?: string; /** * 预留字段。注意：此字段可能返回 null，表示取不到有效值。 */ SetId?: number; /** * 服务绑定的标签。注意：此字段可能返回 null，表示取不到有效值。 */ Tags?: Array<Tag>; /** * 独享实例id 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * 独享实例name 注意：此字段可能返回 null，表示取不到有效值。 */ InstanceName?: string; /** * 集群类型注意：此字段可能返回 null，表示取不到有效值。 */ SetType?: string; /** * 服务部署的集群类型注意：此字段可能返回 null，表示取不到有效值。 */ DeploymentType?: string; /** * 特殊用途, NULL和DEFAULT表示无特殊用途，其他用途如HTTP_DNS等注意：此字段可能返回 null，表示取不到有效值。 */ SpecialUse?: string; /** * vpc属性，存量可能为空字符串注意：此字段可能返回 null，表示取不到有效值。 */ UniqVpcId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 使用计划绑定环境的列表。 */ export interface UsagePlanEnvironmentStatus { /** * 使用计划绑定的服务的环境数。注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * 使用计划已经绑定的各个服务的环境状态。注意：此字段可能返回 null，表示取不到有效值。 */ EnvironmentList: Array<UsagePlanEnvironment>; } /** * DescribeExclusiveInstances请求参数结构体 */ export interface DescribeExclusiveInstancesRequest { /** * 分页查询，limit */ Limit: number; /** * 分页查询，offset */ Offset: number; /** * 过滤条件 */ Filters?: Array<Filter>; } /** * BindSubDomain返回参数结构体 */ export interface BindSubDomainResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BindEnvironment返回参数结构体 */ export interface BindEnvironmentResponse { /** * 绑定操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * API绑定的标签信息。 */ export interface Tag { /** * 标签的 key。 */ Key: string; /** * 便签的 value。 */ Value: string; } /** * DescribeExclusiveInstanceDetail返回参数结构体 */ export interface DescribeExclusiveInstanceDetailResponse { /** * 独享实例详情 */ Result?: InstanceDetail; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeApiBindApiAppsStatus返回参数结构体 */ export interface DescribeApiBindApiAppsStatusResponse { /** * 应用绑定的Api列表。注意：此字段可能返回 null，表示取不到有效值。 */ Result: ApiAppApiInfos; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 常量参数 */ export interface ConstantParameter { /** * 常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ Desc?: string; /** * 常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ Position?: string; /** * 常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ DefaultValue?: string; } /** * DescribeApiForApiApp请求参数结构体 */ export interface DescribeApiForApiAppRequest { /** * API 所在的服务唯一 ID。 */ ServiceId: string; /** * API 接口唯一 ID。 */ ApiId: string; /** * Api所属地域 */ ApiRegion: string; } /** * API文档列表 */ export interface APIDocs { /** * API文档数量 */ TotalCount: number; /** * API文档基本信息 */ APIDocSet: Array<APIDoc>; } /** * 检索条件入参 */ export interface LogQuery { /** * 检索字段 */ Name: string; /** * 操作符 */ Operator: string; /** * 检索值 */ Value: string; } /** * ServiceParameter */ export interface ServiceParameter { /** * API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * API 的后端服务参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。注意：此字段可能返回 null，表示取不到有效值。 */ Position?: string; /** * API 的后端服务参数对应的前端参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ RelevantRequestParameterPosition?: string; /** * API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ RelevantRequestParameterName?: string; /** * API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ DefaultValue?: string; /** * API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ RelevantRequestParameterDesc?: string; /** * API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。注意：此字段可能返回 null，表示取不到有效值。 */ RelevantRequestParameterType?: string; } /** * ModifyService返回参数结构体 */ export interface ModifyServiceResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisableApiKey请求参数结构体 */ export interface DisableApiKeyRequest { /** * 待禁用的密钥 ID。 */ AccessKeyId: string; } /** * 使用计划绑定密钥 */ export interface UsagePlanBindSecret { /** * 密钥ID。注意：此字段可能返回 null，表示取不到有效值。 */ AccessKeyId: string; /** * 密钥名称。注意：此字段可能返回 null，表示取不到有效值。 */ SecretName: string; /** * 密钥状态，0表示已禁用，1表示启用中。注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; } /** * 自定义域名的路径映射。 */ export interface PathMapping { /** * 路径。 */ Path: string; /** * 发布环境，可选值为“test”、 ”prepub“、”release“。 */ Environment: string; } /** * UnBindIPStrategy返回参数结构体 */ export interface UnBindIPStrategyResponse { /** * 解绑操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeExclusiveInstanceDetail请求参数结构体 */ export interface DescribeExclusiveInstanceDetailRequest { /** * 独享实例唯一id */ InstanceId: string; } /** * ModifyPlugin请求参数结构体 */ export interface ModifyPluginRequest { /** * 要修改的插件ID。 */ PluginId: string; /** * 要修改的API网关插件名称。最长50个字符，支持 a-z,A-Z,0-9,_, 必须字母开头，字母或者数字结尾。 */ PluginName?: string; /** * 要修改的插件描述，限定200字以内。 */ Description?: string; /** * 要修改的插件定义语句，支持json。 */ PluginData?: string; } /** * BindIPStrategy返回参数结构体 */ export interface BindIPStrategyResponse { /** * 绑定操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 插件相关的API信息。 */ export interface AvailableApiInfo { /** * API ID。 */ ApiId?: string; /** * API名称。 */ ApiName?: string; /** * API类型。 */ ApiType?: string; /** * API路径。 */ Path?: string; /** * API方法。 */ Method?: string; /** * API是否绑定其他插件。注意：此字段可能返回 null，表示取不到有效值。 */ AttachedOtherPlugin?: boolean; /** * API是否绑定当前插件。注意：此字段可能返回 null，表示取不到有效值。 */ IsAttached?: boolean; } /** * DescribeApisStatus请求参数结构体 */ export interface DescribeApisStatusRequest { /** * API 所在的服务唯一 ID。 */ ServiceId: string; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 返回数量，默认为 20，最大值为 100 */ Limit?: number; /** * API过滤条件。支持ApiId、ApiName、ApiPath、ApiType、AuthRelationApiId、AuthType、ApiBuniessType、NotUsagePlanId、 Environment、Tags (values为 $tag_key:tag_value的列表)、TagKeys （values 为 tag key的列表），其中NotUsagePlanId和Environment必须同时使用，不能单独使用一个。 */ Filters?: Array<Filter>; } /** * DeleteServiceSubDomainMapping请求参数结构体 */ export interface DeleteServiceSubDomainMappingRequest { /** * 服务唯一 ID。 */ ServiceId: string; /** * 服务绑定的自定义域名。 */ SubDomain: string; /** * 待删除映射的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。 */ Environment: string; } /** * BindApiApp请求参数结构体 */ export interface BindApiAppRequest { /** * 待绑定的应用唯一 ID 。 */ ApiAppId: string; /** * 待绑定的环境。 */ Environment: string; /** * 待绑定的服务唯一 ID。 */ ServiceId: string; /** * 待绑定的API唯一ID。 */ ApiId: string; } /** * DescribeIPStrategy返回参数结构体 */ export interface DescribeIPStrategyResponse { /** * IP策略详情。注意：此字段可能返回 null，表示取不到有效值。 */ Result: IPStrategy; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePlugin请求参数结构体 */ export interface DescribePluginRequest { /** * 要查询的插件ID。 */ PluginId: string; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; } /** * DetachPlugin请求参数结构体 */ export interface DetachPluginRequest { /** * 要解绑的API网关插件ID。 */ PluginId: string; /** * 要操作的服务ID。 */ ServiceId: string; /** * 要操作API的环境。 */ EnvironmentName: string; /** * 要解绑的API ID。 */ ApiId: string; } /** * 插件绑定的API信息 */ export interface AttachedApiInfo { /** * API所在服务ID。 */ ServiceId: string; /** * API所在服务名称。 */ ServiceName: string; /** * API所在服务描述信息。注意：此字段可能返回 null，表示取不到有效值。 */ ServiceDesc: string; /** * API ID。 */ ApiId: string; /** * API名称。 */ ApiName: string; /** * API描述。注意：此字段可能返回 null，表示取不到有效值。 */ ApiDesc: string; /** * 插件绑定API的环境。 */ Environment: string; /** * 插件和API绑定时间。 */ AttachedTime: string; } /** * CreateApi返回参数结构体 */ export interface CreateApiResponse { /** * api信息注意：此字段可能返回 null，表示取不到有效值。 */ Result?: CreateApiResultInfo; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIPStrategyApisStatus请求参数结构体 */ export interface DescribeIPStrategyApisStatusRequest { /** * 服务唯一ID。 */ ServiceId: string; /** * 策略唯一ID。 */ StrategyId: string; /** * 策略所在环境。 */ EnvironmentName: string; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 过滤条件。支持 ApiPath、ApiName、KeyWord（模糊查询Path 和Name）。 */ Filters?: Array<Filter>; } /** * ModifyIPStrategy返回参数结构体 */ export interface ModifyIPStrategyResponse { /** * 修改操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询后端通道返回信息 */ export interface DescribeUpstreamInfo { /** * 查询总数 */ TotalCount: number; /** * 查询列表 */ UpstreamSet: Array<UpstreamInfo>; } /** * ModifyApiEnvironmentStrategy请求参数结构体 */ export interface ModifyApiEnvironmentStrategyRequest { /** * 服务唯一ID。 */ ServiceId: string; /** * 限流值。 */ Strategy: number; /** * 环境名。 */ EnvironmentName: string; /** * API列表。 */ ApiIds: Array<string>; } /** * 独享实例网络配置 */ export interface NetworkConfig { /** * 最大出带宽 */ InternetMaxBandwidthOut?: number; /** * EnableInternetInbound信息 */ EnableInternetInbound?: boolean; /** * EnableInternetOutbound信息 */ EnableInternetOutbound?: boolean; /** * InboundIpAddresses信息 */ InboundIpAddresses?: Array<string>; /** * OutboundIpAddresses信息 */ OutboundIpAddresses?: Array<string>; } /** * 服务发布历史 */ export interface ServiceReleaseHistory { /** * 发布版本总数。注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * 历史版本列表。注意：此字段可能返回 null，表示取不到有效值。 */ VersionList: Array<ServiceReleaseHistoryInfo>; } /** * DescribeUpstreamBindApis返回参数结构体 */ export interface DescribeUpstreamBindApisResponse { /** * 查询结果 */ Result: DescribeUpstreamBindApis; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 策略列表 */ export interface IPStrategiesStatus { /** * 策略数量。注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * 策略列表。注意：此字段可能返回 null，表示取不到有效值。 */ StrategySet: Array<IPStrategy>; } /** * CreateUsagePlan返回参数结构体 */ export interface CreateUsagePlanResponse { /** * 使用计划详情。注意：此字段可能返回 null，表示取不到有效值。 */ Result?: UsagePlanInfo; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义服务域名展示 */ export interface DomainSets { /** * 服务下的自定义域名数量。 */ TotalCount: number; /** * 自定义服务域名列表。 */ DomainSet: Array<DomainSetList>; } /** * DeletePlugin请求参数结构体 */ export interface DeletePluginRequest { /** * 要删除的API网关插件的ID。 */ PluginId: string; } /** * Base64编码的header触发规则 */ export interface Base64EncodedTriggerRule { /** * 进行编码触发的header，可选值 "Accept"和"Content_Type" 对应实际数据流请求header中的Accept和 Content-Type。 */ Name: string; /** * 进行编码触发的header的可选值数组, 数组元素的字符串最大长度为40，元素可以包括数字，英文字母以及特殊字符，特殊字符的可选值为： `.` `+` `*` `-` `/` `_` 例如 [ "application/x-vpeg005", "application/xhtml+xml", "application/vnd.ms-project", "application/vnd.rn-rn_music_package" ] 等都是合法的。 */ Value: Array<string>; } /** * 前端路径配置 */ export interface RequestConfig { /** * API 的路径，如 /path。 */ Path: string; /** * API 的请求方法，如 GET。 */ Method: string; } /** * DeleteApiKey返回参数结构体 */ export interface DeleteApiKeyResponse { /** * 删除操作是否成功。注意：此字段可能返回 null，表示取不到有效值。 */ Result?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 环境限流 */ export interface EnvironmentStrategy { /** * 环境名 */ EnvironmentName: string; /** * 限流值 */ Quota: number; } /** * ModifyExclusiveInstance请求参数结构体 */ export interface ModifyExclusiveInstanceRequest { /** * 独享实例唯一id */ InstanceId: string; /** * 独享实例name */ InstanceName?: string; /** * 独享实例描述 */ InstanceDescription?: string; /** * 独享实例参数配置 */ Parameters?: Array<InstanceParameterInput>; } /** * usagePlan详情 */ export interface UsagePlan { /** * 环境名称。 */ Environment: string; /** * 使用计划唯一ID。 */ UsagePlanId: string; /** * 使用计划名称。 */ UsagePlanName: string; /** * 使用计划描述。注意：此字段可能返回 null，表示取不到有效值。 */ UsagePlanDesc: string; /** * 使用计划qps，-1表示没有限制。 */ MaxRequestNumPreSec: number; /** * 使用计划时间。 */ CreatedTime: string; /** * 使用计划修改时间。 */ ModifiedTime: string; } /** * DescribeServiceReleaseVersion请求参数结构体 */ export interface DescribeServiceReleaseVersionRequest { /** * 待查询的服务唯一 ID。 */ ServiceId: string; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为0。 */ Offset?: number; } /** * DescribeUsagePlanSecretIds请求参数结构体 */ export interface DescribeUsagePlanSecretIdsRequest { /** * 绑定的使用计划唯一 ID。 */ UsagePlanId: string; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; } /** * DescribeLogSearch返回参数结构体 */ export interface DescribeLogSearchResponse { /** * 获取更多检索结果的游标，值为""表示无后续结果 */ ConText?: string; /** * 由0或多条日志组成，每条日志格式如下： '[$app_id][$env_name][$service_id][$http_host][$api_id][$uri][$scheme][rsp_st:$status][ups_st:$upstream_status]' '[cip:$remote_addr][uip:$upstream_addr][vip:$server_addr][rsp_len:$bytes_sent][req_len:$request_length]' '[req_t:$request_time][ups_rsp_t:$upstream_response_time][ups_conn_t:$upstream_connect_time][ups_head_t:$upstream_header_time]’ '[err_msg:$err_msg][tcp_rtt:$tcpinfo_rtt][$pid][$time_local][req_id:$request_id]'; 说明： app_id：用户 ID。 env_name：环境名称。 service_id：服务 ID。 http_host：域名。 api_id： API 的 ID。 uri：请求的路径。 scheme： HTTP/HTTPS 协议。 rsp_st：请求响应状态码。 ups_st：后端业务服务器的响应状态码（如果请求透传到后端，改变量不为空。如果请求在 APIGW 就被拦截了，那么该变量显示为 -）。 cip：客户端 IP。 uip：后端业务服务（upstream）的 IP。 vip：请求访问的 VIP。 rsp_len：响应长度。 req_len：请求长度。 req_t：请求响应的总时间。 ups_rsp_t：后端响应的总时间（apigw 建立连接到接收到后端响应的时间）。 ups_conn_t: 与后端业务服务器连接建立成功时间。 ups_head_t：后端响应的头部到达时间。 err_msg：错误信息。 tcp_rtt：客户端 TCP 连接信息，RTT（Round Trip Time）由三部分组成：链路的传播时间（propagation delay）、末端系统的处理时间、路由器缓存中的排队和处理时间（queuing delay）。 req_id：请求id。 */ LogSet?: Array<string>; /** * 单次搜索返回的日志条数，TotalCount <= Limit */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAPIDoc请求参数结构体 */ export interface ModifyAPIDocRequest { /** * API文档名称 */ ApiDocName: string; /** * 服务名称 */ ServiceId: string; /** * 环境名称 */ Environment: string; /** * 生成文档的API列表 */ ApiIds: Array<string>; /** * API文档ID */ ApiDocId: string; } /** * UnBindIPStrategy请求参数结构体 */ export interface UnBindIPStrategyRequest { /** * 待解绑的服务唯一ID。 */ ServiceId: string; /** * 待解绑的IP策略唯一ID。 */ StrategyId: string; /** * 待解绑的环境。 */ EnvironmentName: string; /** * 待解绑的 API 列表。 */ UnBindApiIds: Array<string>; } /** * DescribeUpstreams返回参数结构体 */ export interface DescribeUpstreamsResponse { /** * 查询结果 */ Result: DescribeUpstreamInfo; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePluginApis请求参数结构体 */ export interface DescribePluginApisRequest { /** * 查询的插件ID。 */ PluginId: string; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 偏移量，默认为 0。 */ Offset?: number; } /** * 错误码入参 */ export interface ResponseErrorCodeReq { /** * 自定义响应配置错误码。 */ Code?: number; /** * 自定义响应配置错误信息。 */ Msg?: string; /** * 自定义响应配置错误码备注。 */ Desc?: string; /** * 自定义错误码转换。 */ ConvertedCode?: number; /** * 是否需要开启错误码转换。 */ NeedConvert?: boolean; } /** * 专享查询列表 */ export interface InstanceSummary { /** * 专享实例总数注意：此字段可能返回 null，表示取不到有效值。 */ TotalCount: number; /** * 专享实例列表注意：此字段可能返回 null，表示取不到有效值。 */ InstanceSet: Array<InstanceInfo>; } /** * CreateService请求参数结构体 */ export interface CreateServiceRequest { /** * 用户自定义的服务名称。 */ ServiceName: string; /** * 服务的前端请求类型。如 http、https、http&https。 */ Protocol: string; /** * 用户自定义的服务描述。 */ ServiceDesc?: string; /** * 网络类型列表，用于指定支持的访问类型，INNER为内网访问，OUTER为外网访问。默认为OUTER。 */ NetTypes?: Array<string>; /** * IP版本号，仅支持IPv4。 */ IpVersion?: string; /** * 集群名称。保留字段，tsf serverless类型使用。 */ SetServerName?: string; /** * 用户类型。保留类型，serverless用户使用。 */ AppIdType?: string; /** * 标签。 */ Tags?: Array<Tag>; /** * 独享实例id */ InstanceId?: string; /** * vpc属性，选择VPC后不可修