tenyun

/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** API文档基本信息 */ declare interface APIDoc { /** API文档ID */ ApiDocId?: string; /** API文档名称 */ ApiDocName?: string; /** API文档构建状态 */ ApiDocStatus?: string; /** 标签 */ Tags?: Tag[] | null; } /** API文档详细信息 */ declare interface APIDocInfo { /** API文档ID */ ApiDocId?: string; /** API文档名称 */ ApiDocName?: string; /** API文档构建状态 */ ApiDocStatus?: string; /** API文档API数量 */ ApiCount?: number; /** API文档查看次数 */ ViewCount?: number; /** API文档发布次数 */ ReleaseCount?: number; /** API文档访问URI */ ApiDocUri?: string; /** API文档分享密码 */ SharePassword?: string; /** API文档更新时间 */ UpdatedTime?: string; /** 服务ID */ ServiceId?: string; /** 环境信息 */ Environment?: string; /** 生成API文档的API ID */ ApiIds?: string[]; /** 服务名称 */ ServiceName?: string; /** 生成API文档的API名称 */ ApiNames?: string[]; /** 标签 */ Tags?: Tag[] | null; } /** API文档列表 */ declare interface APIDocs { /** API文档数量 */ TotalCount: number; /** API文档基本信息 */ APIDocSet: APIDoc[]; } /** 应用绑定的Api信息 */ declare interface ApiAppApiInfo { /** 应用名称 */ ApiAppName: string | null; /** 应用ID */ ApiAppId: string; /** Api的ID */ ApiId: string | null; /** Api名称 */ ApiName: string | null; /** 服务ID */ ServiceId: string | null; /** 授权绑定时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ AuthorizedTime: string | null; /** Api所属地域 */ ApiRegion: string | null; /** 授权绑定的环境 */ EnvironmentName: string | null; } /** 应用信息集 */ declare interface ApiAppApiInfos { /** 数量 */ TotalCount: number; /** 应用绑定的Api信息数组 */ ApiAppApiSet: ApiAppApiInfo[] | null; } /** 应用信息 */ declare interface ApiAppInfo { /** 应用名称 */ ApiAppName?: string | null; /** 应用ID */ ApiAppId?: string; /** 应用SECRET注意:此字段可能返回null，表示取不到有效值 */ ApiAppSecret?: string | null; /** 应用描述 */ ApiAppDesc?: string | null; /** 创建时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime?: string | null; /** 修改时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime?: string | null; /** 应用KEY注意:此字段可能返回null，表示取不到有效值 */ ApiAppKey?: string | null; } /** 应用信息集 */ declare interface ApiAppInfos { /** 应用数量 */ TotalCount: number; /** 应用信息数组 */ ApiAppSet: ApiAppInfo[] | null; } /** api环境绑定策略 */ declare interface ApiEnvironmentStrategy { /** API唯一ID。 */ ApiId: string; /** 用户自定义API名称。 */ ApiName: string; /** API的路径。如/path。 */ Path: string; /** API的方法。如GET。 */ Method: string; /** 环境的限流信息。 */ EnvironmentStrategySet: EnvironmentStrategy[]; } /** API绑定策略列表 */ declare interface ApiEnvironmentStrategyStatus { /** API绑定的限流策略数量。 */ TotalCount: number | null; /** API绑定的限流策略列表。 */ ApiEnvironmentStrategySet: ApiEnvironmentStrategy[] | null; } /** API状态 */ declare interface ApiIdStatus { /** 服务唯一ID。 */ ServiceId: string; /** API唯一ID。 */ ApiId: string; /** API描述 */ ApiDesc: string | null; /** API PATH。 */ Path: string; /** API METHOD。 */ Method: string; /** 服务创建时间。 */ CreatedTime: string; /** 服务修改时间。 */ ModifiedTime: string; /** API名称。 */ ApiName: string | null; /** VPC唯一ID。 */ UniqVpcId: string | null; /** API类型。 */ ApiType: string | null; /** API协议。 */ Protocol: string | null; /** 是否买后调试。 */ IsDebugAfterCharge: boolean | null; /** 授权类型。 */ AuthType: string | null; /** API业务类型。 */ ApiBusinessType: string | null; /** 关联授权API唯一ID。 */ AuthRelationApiId: string | null; /** 授权API关联的业务API列表。 */ RelationBuniessApiIds?: string[] | null; /** oauth配置信息。 */ OauthConfig: OauthConfig | null; /** oauth2.0API请求，token存放位置。 */ TokenLocation: string | null; } /** 展示api信息 */ declare interface ApiInfo { /** API 所在的服务唯一 ID。 */ ServiceId?: string | null; /** API 所在的服务的名称。 */ ServiceName?: string | null; /** API 所在的服务的描述。 */ ServiceDesc?: string | null; /** API 接口唯一 ID。 */ ApiId?: string | null; /** API 接口的描述。 */ ApiDesc?: string | null; /** 创建时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime?: string | null; /** 最后修改时间，按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime?: string | null; /** API 接口的名称。 */ ApiName?: string | null; /** API 类型。可取值为NORMAL（普通API）、TSF（微服务API）。 */ ApiType?: string | null; /** API 的前端请求类型，如 HTTP 或 HTTPS 或者 HTTP 和 HTTPS。 */ Protocol?: string | null; /** API 鉴权类型。可取值为 SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH。 */ AuthType?: string | null; /** OAUTH API的类型。可取值为NORMAL（业务API）、OAUTH（授权API）。 */ ApiBusinessType?: string | null; /** OAUTH 业务API 关联的授权API 唯一 ID。 */ AuthRelationApiId?: string | null; /** OAUTH配置。 */ OauthConfig?: OauthConfig | null; /** 是否购买后调试（云市场预留参数）。 */ IsDebugAfterCharge?: boolean | null; /** 请求的前端配置。 */ RequestConfig?: RequestConfig | null; /** 返回类型。 */ ResponseType?: string | null; /** 自定义响应配置成功响应示例。 */ ResponseSuccessExample?: string | null; /** 自定义响应配置失败响应示例。 */ ResponseFailExample?: string | null; /** 用户自定义错误码配置。 */ ResponseErrorCodes?: ErrorCodes[] | null; /** 前端请求参数。 */ RequestParameters?: ReqParameter[] | null; /** API 的后端服务超时时间，单位是秒。 */ ServiceTimeout?: number | null; /** API 的后端服务类型。可取值为 HTTP、MOCK、TSF、CLB、SCF、WEBSOCKET、TARGET（内测）。 */ ServiceType?: string | null; /** API 的后端服务配置。 */ ServiceConfig?: ServiceConfig | null; /** API的后端服务参数。 */ ServiceParameters?: DescribeApiResultServiceParametersInfo[] | null; /** 常量参数。 */ ConstantParameters?: ConstantParameter[] | null; /** API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。 */ ServiceMockReturnMessage?: string | null; /** scf 函数名称。当后端类型是SCF时生效。 */ ServiceScfFunctionName?: string | null; /** scf 函数命名空间。当后端类型是SCF时生效。 */ ServiceScfFunctionNamespace?: string | null; /** scf函数版本。当后端类型是SCF时生效。 */ ServiceScfFunctionQualifier?: string | null; /** 是否开启集成响应。 */ ServiceScfIsIntegratedResponse?: boolean | null; /** scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效 */ ServiceWebsocketRegisterFunctionName?: string | null; /** scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketRegisterFunctionNamespace?: string | null; /** scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketRegisterFunctionQualifier?: string | null; /** scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketCleanupFunctionName?: string | null; /** scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketCleanupFunctionNamespace?: string | null; /** scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketCleanupFunctionQualifier?: string | null; /** WEBSOCKET 回推地址。 */ InternalDomain?: string | null; /** scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketTransportFunctionName?: string | null; /** scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketTransportFunctionNamespace?: string | null; /** scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketTransportFunctionQualifier?: string | null; /** API绑定微服务列表。 */ MicroServices?: MicroService[] | null; /** 微服务信息详情。 */ MicroServicesInfo?: number[] | null; /** 微服务的负载均衡配置。 */ ServiceTsfLoadBalanceConf?: TsfLoadBalanceConfResp | null; /** 微服务的健康检查配置。 */ ServiceTsfHealthCheckConf?: HealthCheckConf | null; /** 是否开启跨域。 */ EnableCORS?: boolean | null; /** API绑定的tag信息。 */ Tags?: Tag[] | null; /** API已发布的环境信息。 */ Environments?: string[] | null; /** 是否开启Base64编码，只有后端为scf时才会生效。 */ IsBase64Encoded?: boolean | null; /** 是否开启Base64编码的header触发，只有后端为scf时才会生效。 */ IsBase64Trigger?: boolean | null; /** Header触发规则，总规则数量不超过10。 */ Base64EncodedTriggerRules?: Base64EncodedTriggerRule[] | null; /** 是否开启SCF Event异步调用。 */ ServiceScfEventIsAsyncCall?: boolean | null; } /** 插件相关的API列表信息。 */ declare interface ApiInfoSummary { /** 插件相关的API总数。 */ TotalCount: number; /** 插件相关的API信息。 */ ApiSet: AvailableApiInfo[]; } /** 密钥详情 */ declare interface ApiKey { /** 创建的 API 密钥 ID 。 */ AccessKeyId?: string; /** 创建的 API 密钥 Key。 */ AccessKeySecret?: string; /** 密钥类型，auto 或者 manual。 */ AccessKeyType?: string; /** 用户自定义密钥名称。 */ SecretName?: string; /** 最后一次修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime?: string; /** 密钥状态。0表示禁用，1表示启用。 */ Status?: number; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime?: string; /** 标签 */ Tags?: Tag[] | null; } /** 密钥列表 */ declare interface ApiKeysStatus { /** 符合条件的 API 密钥数量。 */ TotalCount: number | null; /** API 密钥列表。 */ ApiKeySet: ApiKey[] | null; } /** api请求配置 */ declare interface ApiRequestConfig { /** path */ Path: string; /** 方法 */ Method: string; } /** api或service绑定使用计划详情 */ declare interface ApiUsagePlan { /** 服务唯一ID。 */ ServiceId?: string | null; /** API 唯一 ID。 */ ApiId?: string | null; /** API 名称。 */ ApiName?: string | null; /** API 路径。 */ Path?: string | null; /** API 方法。 */ Method?: string | null; /** 使用计划的唯一 ID。 */ UsagePlanId?: string | null; /** 使用计划的名称。 */ UsagePlanName?: string | null; /** 使用计划的描述。 */ UsagePlanDesc?: string | null; /** 使用计划绑定的服务环境。 */ Environment?: string | null; /** 已经使用的配额。 */ InUseRequestNum?: number | null; /** 请求配额总量，-1表示没有限制。 */ MaxRequestNum?: number | null; /** 请求 QPS 上限，-1 表示没有限制。 */ MaxRequestNumPreSec?: number | null; /** 使用计划创建时间。 */ CreatedTime?: string | null; /** 使用计划最后修改时间。 */ ModifiedTime?: string | null; /** 服务名称。 */ ServiceName?: string | null; /** 标签 */ Tags?: Tag[] | null; } /** api绑定使用计划列表 */ declare interface ApiUsagePlanSet { /** API 绑定的使用计划总数。 */ TotalCount: number | null; /** API 绑定使用计划列表。 */ ApiUsagePlanList: ApiUsagePlan[] | null; } /** key-value */ declare interface ApigatewayTags { } /** 插件绑定的API信息 */ declare interface AttachedApiInfo { /** API所在服务ID。 */ ServiceId: string; /** API所在服务名称。 */ ServiceName: string; /** API所在服务描述信息。 */ ServiceDesc: string | null; /** API ID。 */ ApiId: string; /** API名称。 */ ApiName: string; /** API描述。 */ ApiDesc: string | null; /** 插件绑定API的环境。 */ Environment: string; /** 插件和API绑定时间。 */ AttachedTime: string; } /** 插件绑定的API列表 */ declare interface AttachedApiSummary { /** 插件绑定的API数量。 */ TotalCount: number; /** 插件绑定的API信息。 */ AttachedApis: AttachedApiInfo[]; } /** 已绑定的插件信息。 */ declare interface AttachedPluginInfo { /** 插件ID。 */ PluginId: string; /** 环境信息。 */ Environment: string; /** 绑定时间。 */ AttachedTime: string; /** 插件名称。 */ PluginName: string; /** 插件类型。 */ PluginType: string; /** 插件描述。 */ Description: string; /** 插件定义语句。 */ PluginData: string; } /** 已绑定的插件信息。 */ declare interface AttachedPluginSummary { /** 已绑定的插件总数。 */ TotalCount: number; /** 已绑定的插件信息。 */ PluginSummary: AttachedPluginInfo[]; } /** 插件相关的API信息。 */ declare interface AvailableApiInfo { /** API ID。 */ ApiId?: string; /** API名称。 */ ApiName?: string; /** API类型。 */ ApiType?: string; /** API路径。 */ Path?: string; /** API方法。 */ Method?: string; /** API是否绑定其他插件。 */ AttachedOtherPlugin?: boolean | null; /** API是否绑定当前插件。 */ IsAttached?: boolean | null; } /** Base64编码的header触发规则 */ declare 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: string[]; } /** vpc通道绑定的api信息 */ declare interface BindApiInfo { /** api唯一id */ ApiId: string; /** Service唯一id */ ServiceId: string; /** api名字 */ ApiName: string | null; /** 服务名字 */ ServiceName: string | null; /** 绑定时间 */ BindTime: string; } /** 常量参数 */ declare interface ConstantParameter { /** 常量参数名称。只有 ServiceType 是 HTTP 才会用到此参数。 */ Name?: string | null; /** 常量参数描述。只有 ServiceType 是 HTTP 才会用到此参数。 */ Desc?: string | null; /** 常量参数位置。只有 ServiceType 是 HTTP 才会用到此参数。 */ Position?: string | null; /** 常量参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。 */ DefaultValue?: string | null; } /** cos类型的api配置 */ declare interface CosConfig { /** API调用后端COS的方式，前端请求方法与Action的可选值为：GET：GetObjectPUT：PutObjectPOST：PostObject、AppendObjectHEAD： HeadObjectDELETE： DeleteObject。 */ Action: string | null; /** API后端COS的存储桶名。 */ BucketName: string | null; /** API调用后端COS的签名开关，默认为false。 */ Authorization?: boolean | null; /** API后端COS的路径匹配模式，可选值：BackEndPath ：后端路径匹配FullPath ：全路径匹配默认值为：BackEndPath */ PathMatchMode?: string | null; } /** 创建api返回 */ declare interface CreateApiResultInfo { /** api id */ ApiId: string | null; /** 路径 */ Path: string | null; /** 请求方法 */ Method: string | null; /** 创建时间 */ CreatedTime: string | null; } /** 创建api返回 */ declare interface CreateApiRsp { /** api id */ ApiId: string | null; /** 路径 */ Path: string | null; /** 请求方法 */ Method: string | null; /** 创建时间 */ CreatedTime: string | null; /** 导入状态 */ Status: string | null; /** 异常信息 */ ErrMsg: string | null; /** api name */ ApiName: string | null; } /** CreateApiRsp 返回加TotalCount */ declare interface CreateApiRspSet { /** 个数 */ TotalCount: number; /** 返回的数组 */ ApiSet: CreateApiRsp[]; } /** api状态详情 */ declare interface DesApisStatus { /** 服务唯一ID。 */ ServiceId: string; /** API唯一ID。 */ ApiId: string; /** 用户自定义的 API 接口描述。 */ ApiDesc: string | null; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime: string | null; /** 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime: string | null; /** API 接口的名称。 */ ApiName: string | null; /** VPCID。 */ VpcId: number | null; /** VPC唯一ID。 */ UniqVpcId: string | null; /** API类型。取值为NORMAL（普通API）和TSF（微服务API）。 */ ApiType: string | null; /** API协议。 */ Protocol: string | null; /** 是否买后调试。（云市场预留字段） */ IsDebugAfterCharge: boolean | null; /** API 鉴权类型。取值为SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH、EIAM。 */ AuthType: string | null; /** OAUTH API的类型。当AuthType 为 OAUTH时该字段有效，取值为NORMAL（业务API）和 OAUTH（授权API）。 */ ApiBusinessType: string | null; /** 关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。 */ AuthRelationApiId: string | null; /** OAUTH 配置信息。当AuthType是OAUTH时生效。 */ OauthConfig: OauthConfig | null; /** 授权API关联的业务API列表。 */ RelationBuniessApiIds?: string[] | null; /** API关联的标签信息。 */ Tags: string[] | null; /** API 的路径，如 /path。 */ Path: string | null; /** API 的请求方法，如 GET。 */ Method: string | null; } /** ServiceParameter */ declare interface DescribeApiResultServiceParametersInfo { /** API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。 */ Name?: string | null; /** API 的后端服务参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。 */ Position?: string | null; /** API 的后端服务参数对应的前端参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。 */ RelevantRequestParameterPosition?: string | null; /** API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。 */ RelevantRequestParameterName?: string | null; /** API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。 */ DefaultValue?: string | null; /** API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。 */ RelevantRequestParameterDesc?: string | null; } /** api状态详情 */ declare interface DescribeApisStatusResultApiIdStatusSetInfo { /** 服务唯一ID。 */ ServiceId: string; /** API唯一ID。 */ ApiId: string; /** 用户自定义的 API 接口描述。 */ ApiDesc: string | null; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime: string | null; /** 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime: string | null; /** API 接口的名称。 */ ApiName: string | null; /** VPCID。 */ VpcId: number | null; /** VPC唯一ID。 */ UniqVpcId: string | null; /** API类型。取值为NORMAL（普通API）和TSF（微服务API）。 */ ApiType: string | null; /** API协议。 */ Protocol: string | null; /** 是否买后调试。（云市场预留字段） */ IsDebugAfterCharge: boolean | null; /** API 鉴权类型。取值为SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH、EIAM。 */ AuthType: string | null; /** OAUTH API的类型。当AuthType 为 OAUTH时该字段有效，取值为NORMAL（业务API）和 OAUTH（授权API）。 */ ApiBusinessType: string | null; /** 关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。 */ AuthRelationApiId: string | null; /** OAUTH 配置信息。当AuthType是OAUTH时生效。 */ OauthConfig: OauthConfig | null; /** 授权API关联的业务API列表。 */ RelationBuniessApiIds?: string[] | null; /** API关联的标签信息。 */ Tags: ApigatewayTags[] | null; /** API 的路径，如 /path。 */ Path: string | null; /** API 的请求方法，如 GET。 */ Method: string | null; } /** 描述api列表状态 */ declare interface DescribeApisStatusResultInfo { /** 符合条件的 API 接口数量。 */ TotalCount: number; /** API 接口列表。 */ ApiIdStatusSet: DescribeApisStatusResultApiIdStatusSetInfo[]; } /** 数据结构 */ declare interface DescribeExclusiveInstancesResult { } /** 服务发布列表详情 */ declare interface DescribeServiceReleaseVersionResultVersionListInfo { /** 版本号。 */ VersionName: string | null; /** 版本描述。 */ VersionDesc: string | null; } /** 查询后端通道绑定API列表 */ declare interface DescribeUpstreamBindApis { /** 总数 */ TotalCount: number; /** 绑定的API信息 */ BindApiSet: BindApiInfo[]; } /** 查询后端通道返回信息 */ declare interface DescribeUpstreamInfo { /** 查询总数 */ TotalCount: number; /** 查询列表 */ UpstreamSet: UpstreamInfo[]; } /** 服务自定义域名列表 */ declare interface DomainSetList { /** 域名名称。 */ DomainName: string; /** 域名解析状态。1 表示正常解析，0 表示解析失败。 */ Status: number; /** 证书ID。 */ CertificateId: string; /** 是否使用默认路径映射。 */ IsDefaultMapping: boolean; /** 自定义域名协议类型。 */ Protocol: string; /** 网络类型（'INNER' 或 'OUTER'）。 */ NetType: string; /** 是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。 */ IsForcedHttps: boolean; /** 域名备案注册状态 */ RegistrationStatus: boolean; } /** 自定义服务域名展示 */ declare interface DomainSets { /** 服务下的自定义域名数量。 */ TotalCount: number; /** 自定义服务域名列表。 */ DomainSet: DomainSetList[]; } /** 服务发布的环境信息。 */ declare interface Environment { /** 环境名称。 */ EnvironmentName?: string; /** 访问路径。 */ Url?: string; /** 发布状态，1 表示已发布，0 表示未发布。 */ Status?: number; /** 运行版本。 */ VersionName?: string; /** 创建时间 */ CreateTime?: string | null; } /** 环境限流 */ declare interface EnvironmentStrategy { /** 环境名 */ EnvironmentName: string; /** 限流值 */ Quota: number; } /** 用户自定义错误码 */ declare interface ErrorCodes { /** 自定义响应配置错误码。 */ Code?: number | null; /** 自定义响应配置错误信息。 */ Msg?: string | null; /** 自定义响应配置错误码备注。 */ Desc?: string | null; /** 自定义错误码转换。 */ ConvertedCode?: number | null; /** 是否需要开启错误码转换。 */ NeedConvert?: boolean | null; } /** >描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等> * 若存在多个`Filter`时，`Filter`间的关系为逻辑与（`AND`）关系。> * 若同一个`Filter`存在多个`Values`，同一`Filter`下`Values`间的关系为逻辑或（`OR`）关系。> */ declare interface Filter { /** 需要过滤的字段。 */ Name: string; /** 字段的过滤值。 */ Values: string[]; } /** 健康检查配置，包括TsfHealthCheckConf和TargetServicesHealthCheckConf */ declare interface HealthCheckConf { /** 是否开启健康检查。 */ IsHealthCheck?: boolean | null; /** 健康检查阈值。 */ RequestVolumeThreshold?: number | null; /** 窗口大小。 */ SleepWindowInMilliseconds?: number | null; /** 阈值百分比。 */ ErrorThresholdPercentage?: number | null; } /** 策略列表 */ declare interface IPStrategiesStatus { /** 策略数量。 */ TotalCount: number | null; /** 策略列表。 */ StrategySet: IPStrategy[] | null; } /** ip策略 */ declare interface IPStrategy { /** 策略唯一ID。 */ StrategyId: string | null; /** 用户自定义策略名称。 */ StrategyName: string | null; /** 策略类型。支持WHITE（白名单）和BLACK（黑名单）。 */ StrategyType: string | null; /** IP列表。 */ StrategyData: string | null; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime: string | null; /** 修改时间。 */ ModifiedTime: string | null; /** 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ServiceId: string | null; /** 策略绑定的API数量。 */ BindApiTotalCount: number | null; /** 绑定的API详情。 */ BindApis: DesApisStatus[] | null; } /** 策略绑定api列表 */ declare interface IPStrategyApi { /** API 唯一 ID。 */ ApiId: string; /** 用户自定义的 API 名称。 */ ApiName: string; /** API 类型。取值为NORMAL（普通API）和TSF （微服务API）。 */ ApiType: string; /** API 的路径。如 /path。 */ Path: string; /** API 的请求方法。如 GET。 */ Method: string; /** API 已经绑定的其他策略唯一ID。 */ OtherIPStrategyId: string; /** API 已经绑定的环境。 */ OtherEnvironmentName: string; } /** ip策略绑定api详情 */ declare interface IPStrategyApiStatus { /** 环境绑定API数量。 */ TotalCount: number | null; /** 环境绑定API详情。 */ ApiIdStatusSet: IPStrategyApi[] | null; } /** 独享实例预付费详情 */ declare interface InstanceChargePrepaid { /** 自动续费标示 */ RenewFlag: string; /** 预付费到期时间 */ ExpiredTime: string; } /** 独享实例详情 */ declare interface InstanceDetail { /** 独享实例唯一id */ InstanceId?: string; /** 可用区 */ Zone?: string; /** 独享实例名字 */ InstanceName?: string; /** 独享实例描述 */ InstanceDescription?: string; /** 独享实例计费类型 */ InstanceChargeType?: string; /** 独享实例状态 */ InstanceState?: string; /** 独享实例预付费类型 */ InstanceChargePrepaid?: InstanceChargePrepaid | null; /** 独享实例类型 */ InstanceType?: string; /** 独享实例网络类型 */ NetworkConfig?: NetworkConfig | null; /** 独享实例vpc配置 */ VpcConfig?: VpcConfig; /** 独享实例参数配置 */ Parameters?: ParameterInfo[] | null; /** 独享实例隔离时间 */ IsolationStartedTime?: string; /** 创建时间 */ CreatedTime?: string; /** 可用区列表 */ Zones?: string[] | null; } /** 独享实例信息 */ declare interface InstanceInfo { /** 独享实例唯一id */ InstanceId?: string; /** 独享实例name */ InstanceName?: string; /** 独享实例描述 */ InstanceDescription?: string; /** 独享实例计费类型 */ InstanceChargeType?: string; /** 独享实例类型 */ InstanceType?: string; /** 独享实例状态 */ InstanceState?: string; /** 独享实例创建时间 */ CreatedTime?: string; /** 订单号 */ DealName?: string | null; /** 资源ID同唯一id */ ResourceId?: string; /** 公网IP列表 */ OuterIpList?: string[] | null; /** 内网IP列表 */ InnerIpList?: string[] | null; /** 专享实例计费信息 */ InstanceChargePrepaid?: InstanceChargePrepaid | null; /** 所属vpc */ UniqVpcId?: string | null; } /** 专享网络配置 */ declare interface InstanceNetworkConfig { /** 公网带宽 */ InternetMaxBandwidthOut: number; } /** 独享实例参数信息 */ declare interface InstanceParameterInput { /** ServiceRequestNumPreSec，ApiRequestNumPreSec */ Name: string; /** 参数值 */ Value: string; } /** 专享查询列表 */ declare interface InstanceSummary { /** 专享实例总数 */ TotalCount: number | null; /** 专享实例列表 */ InstanceSet: InstanceInfo[] | null; } /** k8s Label */ declare interface K8sLabel { /** Label的Key */ Key: string; /** Label的Value */ Value: string; } /** k8s 服务的配置 */ declare interface K8sService { /** 权重 */ Weight: number; /** k8s集群ID */ ClusterId: string; /** 容器命名空间 */ Namespace: string; /** 容器服务的名字 */ ServiceName: string; /** 服务的端口 */ Port: number; /** 额外选择的Pod的Label */ ExtraLabels: K8sLabel[]; /** 自定义的服务名字，可选 */ Name?: string; } /** 检索条件入参 */ declare interface LogQuery { /** 检索字段 */ Name: string; /** 操作符 */ Operator: string; /** 检索值 */ Value: string; } /** API绑定的微服务信息。 */ declare interface MicroService { /** 微服务集群ID。 */ ClusterId?: string; /** 微服务命名空间ID。 */ NamespaceId?: string; /** 微服务名称。 */ MicroServiceName?: string; } /** tsf类型入参 */ declare interface MicroServiceReq { /** 微服务集群。 */ ClusterId: string; /** 微服务命名空间。 */ NamespaceId: string; /** 微服务名称。 */ MicroServiceName: string; } /** 后端通道详细信息 */ declare interface ModifyUpstreamResultInfo { /** 后端通道唯一ID */ UpstreamId: string; /** 后端通道名字 */ UpstreamName: string; /** 后端通道描述 */ UpstreamDescription: string; /** 后端协议，取值范围：HTTP, HTTPS */ Scheme: string; /** 负载均衡算法，取值范围：ROUND_ROBIN */ Algorithm: string; /** VPC唯一ID */ UniqVpcId: string; /** 请求重试次数 */ Retries: number; /** 后端节点 */ Nodes: UpstreamNode[]; /** 创建时间 */ CreatedTime: string; /** 健康检查配置 */ HealthChecker: UpstreamHealthChecker | null; /** 后端的类型，取值范围：IP_PORT, K8S */ UpstreamType: string; /** K8S容器服务配置 */ K8sServices: K8sService[] | null; /** 网关转发给后端的Host请求头 */ UpstreamHost: string | null; } /** 独享实例网络配置 */ declare interface NetworkConfig { /** 最大出带宽 */ InternetMaxBandwidthOut?: number; /** EnableInternetInbound信息 */ EnableInternetInbound?: boolean; /** EnableInternetOutbound信息 */ EnableInternetOutbound?: boolean; /** InboundIpAddresses信息 */ InboundIpAddresses?: string[]; /** OutboundIpAddresses信息 */ OutboundIpAddresses?: string[]; } /** Oauth授权配置信息 */ declare interface OauthConfig { /** 公钥，用于验证用户token。 */ PublicKey: string; /** token传递位置。 */ TokenLocation: string; /** 重定向地址，用于引导用户登录操作。 */ LoginRedirectUrl?: string; } /** 独享实例配置参数 */ declare interface ParameterInfo { /** 名字 */ Name?: string; /** 当前值 */ Value?: number; /** 默认值 */ Default?: number; /** 单位 */ Unit?: string; /** 类型, integer|string */ Type?: string; /** 最小 */ Minimum?: number; /** 最大 */ Maximum?: number; /** 修改时间 */ ModifedTime?: string; /** 字符类型的值，当Type为string时才有意义 */ ValueString?: string | null; /** 字符类型的默认值，当Type为string时才有意义 */ DefaultValueString?: string | null; /** 可调整范围 */ Range?: string | null; } /** 自定义域名的路径映射。 */ declare interface PathMapping { /** 路径。 */ Path: string; /** 发布环境，可选值为“test”、 ”prepub“、”release“。 */ Environment: string; } /** API网关插件详情。 */ declare interface Plugin { /** 插件ID。 */ PluginId: string; /** 插件名称。 */ PluginName: string; /** 插件类型。 */ PluginType: string; /** 插件定义语句。 */ PluginData: string; /** 插件描述。 */ Description: string | null; /** 插件创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime: string; /** 插件修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime: string; /** 插件绑定的API总数。 */ AttachedApiTotalCount: number | null; /** 插件绑定的API信息。 */ AttachedApis: AttachedApiInfo[] | null; } /** 插件列表详情。 */ declare interface PluginSummary { /** 插件个数。 */ TotalCount: number; /** 插件详情。 */ PluginSet: Plugin[]; } /** 发布服务返回 */ declare interface ReleaseService { /** 发布时的备注信息填写。 */ ReleaseDesc: string | null; /** 发布的版本id。 */ ReleaseVersion: string | null; } /** 请求参数 */ declare interface ReqParameter { /** API 的前端参数名称。 */ Name: string; /** API 的前端参数位置，如 header。目前支持 header、query、path。 */ Position: string; /** API 的前端参数类型，如 String、int。 */ Type: string; /** API 的前端参数默认值。 */ DefaultValue: string; /** API 的前端参数是否必填，True：表示必填，False：表示可选。 */ Required: boolean; /** API 的前端参数备注。 */ Desc: string; } /** 前端路径配置 */ declare interface RequestConfig { /** API 的路径，如 /path。 */ Path: string; /** API 的请求方法，如 GET。 */ Method: string; } /** 请求参数 */ declare interface RequestParameter { /** 请求参数名称 */ Name?: string; /** 描述 */ Desc?: string; /** 参数位置 */ Position?: string; /** 参数类型 */ Type?: string; /** 默认值 */ DefaultValue?: string; /** 是否必须 */ Required?: boolean; } /** 错误码入参 */ declare interface ResponseErrorCodeReq { /** 自定义响应配置错误码。 */ Code?: number; /** 自定义响应配置错误信息。 */ Msg?: string; /** 自定义响应配置错误码备注。 */ Desc?: string; /** 自定义错误码转换。 */ ConvertedCode?: number; /** 是否需要开启错误码转换。 */ NeedConvert?: boolean; } /** 展示服务列表用 */ declare interface Service { /** 内网访问https端口。 */ InnerHttpsPort: number | null; /** 用户自定义的服务描述。 */ ServiceDesc: string | null; /** 服务的前端请求类型。如http、https 或者 http&https。 */ Protocol: string | null; /** 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime: string | null; /** 服务支持的网络类型。 */ NetTypes: string[] | null; /** 独占集群名称。 */ ExclusiveSetName: string | null; /** 服务唯一 ID。 */ ServiceId: string | null; /** IP版本。 */ IpVersion: string | null; /** 已经发布的环境列表。如test、prepub、release。 */ AvailableEnvironments: string[] | null; /** 用户自定义的服务名称。 */ ServiceName: string | null; /** 系统为该服务分配的外网域名。 */ OuterSubDomain: string | null; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime: string | null; /** 内网访问http端口。 */ InnerHttpPort: number | null; /** 系统为该服务自动分配的内网域名。 */ InnerSubDomain: string | null; /** 服务的计费状态。 */ TradeIsolateStatus: number | null; /** 服务绑定的标签 */ Tags: Tag[] | null; /** 独享实例 */ InstanceId: string | null; /** 集群类型 */ SetType: string | null; /** 服务部署的集群类型 */ DeploymentType: string | null; } /** ServiceConfig配置 */ declare 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通道才需要 */ UpstreamId?: string | null; /** API后端COS配置。如果 ServiceType 是 COS，则此参数必传。 */ CosConfig?: CosConfig | null; } /** 服务绑定环境详情 */ declare interface ServiceEnvironmentSet { /** 服务绑定环境总数。 */ TotalCount: number | null; /** 服务绑定环境列表。 */ EnvironmentList: Environment[] | null; } /** 服务环境策略 */ declare interface ServiceEnvironmentStrategy { /** 环境名。 */ EnvironmentName: string; /** 访问服务对应环境的url。 */ Url: string; /** 发布状态。 */ Status: number; /** 发布的版本号。 */ VersionName: string | null; /** 限流值。 */ Strategy: number; /** 最大限流值 */ MaxStrategy: number | null; } /** 环境绑定策略列表 */ declare interface ServiceEnvironmentStrategyStatus { /** 限流策略数量。 */ TotalCount: number | null; /** 限流策略列表。 */ EnvironmentList: ServiceEnvironmentStrategy[] | null; } /** ServiceParameter */ declare interface ServiceParameter { /** API的后端服务参数名称。只有ServiceType是HTTP才会用到此参数。前后端参数名称可不同。 */ Name?: string | null; /** API 的后端服务参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。前后端参数位置可配置不同。 */ Position?: string | null; /** API 的后端服务参数对应的前端参数位置，如 head。只有 ServiceType 是 HTTP 才会用到此参数。 */ RelevantRequestParameterPosition?: string | null; /** API 的后端服务参数对应的前端参数名称。只有 ServiceType 是 HTTP 才会用到此参数。 */ RelevantRequestParameterName?: string | null; /** API 的后端服务参数默认值。只有 ServiceType 是 HTTP 才会用到此参数。 */ DefaultValue?: string | null; /** API 的后端服务参数备注。只有 ServiceType 是 HTTP 才会用到此参数。 */ RelevantRequestParameterDesc?: string | null; /** API 的后端服务参数类型。只有 ServiceType 是 HTTP 才会用到此参数。 */ RelevantRequestParameterType?: string | null; } /** 服务发布历史 */ declare interface ServiceReleaseHistory { /** 发布版本总数。 */ TotalCount: number | null; /** 历史版本列表。 */ VersionList: ServiceReleaseHistoryInfo[] | null; } /** 服务发布列表详情 */ declare interface ServiceReleaseHistoryInfo { /** 版本号。 */ VersionName?: string | null; /** 版本描述。 */ VersionDesc?: string | null; /** 版本发布时间。 */ ReleaseTime?: string | null; } /** 服务发布版本 */ declare interface ServiceReleaseVersion { /** 发布版本总数量。 */ TotalCount: number | null; /** 发布版本列表。 */ VersionList: DescribeServiceReleaseVersionResultVersionListInfo[] | null; } /** 服务自定义域名路径映射 */ declare interface ServiceSubDomainMappings { /** 是否使用默认路径映射，为 True 表示使用默认路径映射；为 False 的话，表示使用自定义路径映射，此时 PathMappingSet 不为空。 */ IsDefaultMapping: boolean; /** 自定义路径映射列表。 */ PathMappingSet: PathMapping[]; } /** 服务绑定使用计划列表 */ declare interface ServiceUsagePlanSet { /** 服务上绑定的使用计划总数。 */ TotalCount: number | null; /** 服务上绑定的使用计划列表。 */ ServiceUsagePlanList: ApiUsagePlan[] | null; } /** 服务列表展示 */ declare interface ServicesStatus { /** 服务列表总数。 */ TotalCount: number | null; /** 服务列表详情。 */ ServiceSet: Service[] | null; } /** API绑定的标签信息。 */ declare interface Tag { /** 标签的 key。 */ Key: string; /** 便签的 value。 */ Value: string; } /** tsf serverless入参 */ declare interface TargetServicesReq { /** vm ip */ VmIp: string; /** vpc id */ VpcId: string; /** vm port */ VmPort: number; /** cvm所在宿主机ip */ HostIp: string; /** docker ip */ DockerIp?: string; } /** TsfLoadBalanceConf 出参使用 */ declare interface TsfLoadBalanceConfResp { /** 是否开启负载均衡。 */ IsLoadBalance?: boolean | null; /** 负载均衡方式。 */ Method?: string | null; /** 是否开启会话保持。 */ SessionStickRequired?: boolean | null; /** 会话保持超时时间。 */ SessionStickTimeout?: number | null; } /** 后端通道健康检查参数配置 */ declare interface UpstreamHealthChecker { /** 标识是否开启主动健康检查。 */ EnableActiveCheck: boolean; /** 标识是否开启被动健康检查。 */ EnablePassiveCheck: boolean; /** 健康检查时，判断为成功请求的 HTTP 状态码。 */ HealthyHttpStatus: string; /** 健康检查时，判断为失败请求的 HTTP 状态码。 */ UnhealthyHttpStatus: string; /** TCP连续错误阈值。0 表示禁用 TCP 检查。取值范围：[0, 254]。 */ TcpFailureThreshold: number; /** 连续超时阈值。0 表示禁用超时检查。取值范围：[0, 254]。 */ TimeoutThreshold: number; /** HTTP连续错误阈值。0 表示禁用HTTP检查。取值范围：[0, 254]。 */ HttpFailureThreshold: number; /** 主动健康检查时探测请求的路径。默认为"/"。 */ ActiveCheckHttpPath?: string; /** 主动健康检查的探测请求超时，单位秒。默认为5秒。 */ ActiveCheckTimeout?: number; /** 主动健康检查的时间间隔，默认5秒。 */ ActiveCheckInterval?: number; /** 主动健康检查时探测请求的的请求头。 */ ActiveRequestHeader?: UpstreamHealthCheckerReqHeaders[]; /** 异常节点的状态自动恢复时间，单位秒。当只开启被动检查的话，必须设置为 > 0 的值，否则被动异常节点将无法恢复。默认30秒。 */ UnhealthyTimeout?: number; } /** 后端通道主动健康检查的请求头配置 */ declare interface UpstreamHealthCheckerReqHeaders { } /** 后端通道详细信息 */ declare interface UpstreamInfo { /** 后端通道唯一ID */ UpstreamId: string; /** 后端通道名字 */ UpstreamName: string; /** 后端通道描述 */ UpstreamDescription: string; /** 后端协议，取值范围：HTTP, HTTPS */ Scheme: string; /** 负载均衡算法，取值范围：ROUND_ROBIN */ Algorithm: string; /** VPC唯一ID */ UniqVpcId: string; /** 请求重试次数 */ Retries: number; /** 后端节点 */ Nodes: UpstreamNode[]; /** 创建时间 */ CreatedTime: string; /** 标签 */ Tags: Tag[] | null; /** 健康检查配置 */ HealthChecker: UpstreamHealthChecker | null; /** 后端的类型，取值范围：IP_PORT, K8S */ UpstreamType: string; /** K8S容器服务配置 */ K8sServices: K8sService[] | null; /** 网关转发给后端的Host请求头 */ UpstreamHost: string | null; } /** 后端通道后端节点元数据 */ declare interface UpstreamNode { /** IP或域名 */ Host: string; /** 端口[0, 65535] */ Port: number; /** 权重[0, 100], 0为禁用 */ Weight: number; /** CVM实例ID */ VmInstanceId?: string | null; /** 染色标签 */ Tags?: string[] | null; /** 节点健康状态，创建、编辑时不需要传该参数。OFF：关闭，HEALTHY：健康，UNHEALTHY：异常，NO_DATA：数据未上报。目前只支持VPC通道。 */ Healthy?: string | null; /** K8S容器服务名字 */ ServiceName?: string | null; /** K8S命名空间 */ NameSpace?: string | null; /** TKE集群的ID */ ClusterId?: string | null; /** Node的来源，取值范围：K8S */ Source?: string | null; /** API网关内部记录唯一的服务名字 */ UniqueServiceName?: string | null; } /** usagePlan详情 */ declare interface UsagePlan { /** 环境名称。 */ Environment: string; /** 使用计划唯一ID。 */ UsagePlanId: string; /** 使用计划名称。 */ UsagePlanName: string; /** 使用计划描述。 */ UsagePlanDesc: string | null; /** 使用计划qps，-1表示没有限制。 */ MaxRequestNumPreSec: number; /** 使用计划时间。 */ CreatedTime: string; /** 使用计划修改时间。 */ ModifiedTime: string; } /** 使用计划绑定环境信息 */ declare interface UsagePlanBindEnvironment { /** 环境名。 */ EnvironmentName: string | null; /** 服务唯一ID。 */ ServiceId: string | null; } /** 使用计划绑定密钥 */ declare interface UsagePlanBindSecret { /** 密钥ID。 */ AccessKeyId: string | null; /** 密钥名称。 */ SecretName: string | null; /** 密钥状态，0表示已禁用，1表示启用中。 */ Status: number | null; } /** 使用计划绑定密钥列表 */ declare interface UsagePlanBindSecretStatus { /** 使用计划绑定密钥的数量。 */ TotalCount: number | null; /** 密钥详情列表。 */ AccessKeyList: UsagePlanBindSecret[] | null; } /** 使用计划绑定环境详情。 */ declare interface UsagePlanEnvironment { /** 绑定的服务唯一 ID。 */ ServiceId: string | null; /** API 的唯一ID。 */ ApiId: string | null; /** API 的名称。 */ ApiName: string | null; /** API 的路径。 */ Path: string | null; /** API 的方法。 */ Method: string | null; /** 已经绑定的环境名称。 */ Environment: string | null; /** 已经使用的配额。 */ InUseRequestNum: number | null; /** 最大请求量。 */ MaxRequestNum: number | null; /** 每秒最大请求次数。 */ MaxRequestNumPreSec: number | null; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime: string | null; /** 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime: string | null; /** 服务名称。 */ ServiceName: string | null; } /** 使用计划绑定环境的列表。 */ declare interface UsagePlanEnvironmentStatus { /** 使用计划绑定的服务的环境数。 */ TotalCount: number | null; /** 使用计划已经绑定的各个服务的环境状态。 */ EnvironmentList: UsagePlanEnvironment[] | null; } /** 使用计划详情。 */ declare interface UsagePlanInfo { /** 使用计划唯一 ID。 */ UsagePlanId?: string | null; /** 使用计划名称。 */ UsagePlanName?: string | null; /** 使用计划描述。 */ UsagePlanDesc?: string | null; /** 每秒请求限制数。 */ MaxRequestNumPreSec?: number | null; /** 最大调用次数。 */ MaxRequestNum?: number | null; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime?: string | null; /** 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime?: string | null; /** 绑定密钥的数量。 */ BindSecretIdTotalCount?: number | null; /** 绑定密钥的详情。 */ BindSecretIds?: string[] | null; /** 绑定环境数量。 */ BindEnvironmentTotalCount?: number | null; /** 绑定环境详情。 */ BindEnvironments?: UsagePlanBindEnvironment[] | null; /** 标签 */ Tags?: Tag[] | null; } /** 用于使用计划列表展示 */ declare interface UsagePlanStatusInfo { /** 使用计划唯一 ID。 */ UsagePlanId?: string | null; /** 用户自定义的使用计划名称。 */ UsagePlanName?: string | null; /** 用户自定义的使用计划描述。 */ UsagePlanDesc?: string | null; /** 每秒最大请求次数。 */ MaxRequestNumPreSec?: number | null; /** 请求配额总量，-1表示没有限制。 */ MaxRequestNum?: number | null; /** 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime?: string | null; /** 最后修改时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ ModifiedTime?: string | null; /** 标签 */ Tags?: Tag[] | null; } /** 使用计划列表 */ declare interface UsagePlansStatus { /** 符合条件的使用计划数量。 */ TotalCount: number | null; /** 使用计划列表。 */ UsagePlanStatusSet: UsagePlanStatusInfo[] | null; } /** 独享实例vpc配置信息 */ declare interface VpcConfig { /** vpcid */ UniqVpcId: string; /** subnetid */ UniqSubnetId: string; } declare interface AttachPluginRequest { /** 绑定的API网关插件ID。 */ PluginId: string; /** 要操作的服务ID。 */ ServiceId: string; /** 要操作API的环境。 */ EnvironmentName: string; /** 要绑定的API列表。 */ ApiIds: string[]; } declare interface AttachPluginResponse { /** 绑定操作是否成功。 */ Result?: boolean; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface BindApiAppRequest { /** 待绑定的应用唯一 ID 。 */ ApiAppId: string; /** 待绑定的环境。 */ Environment: string; /** 待绑定的服务唯一 ID。 */ ServiceId: string; /** 待绑定的API唯一ID。 */ ApiId: string; } declare interface BindApiAppResponse { /** 绑定操作是否成功。 */ Result: boolean | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface BindEnvironmentRequest { /** 待绑定的使用计划唯一 ID 列表。 */ UsagePlanIds: string[]; /** 绑定类型，取值为API、SERVICE，默认值为SERVICE。 */ BindType: string; /** 待绑定的环境。 */ Environment: string; /** 待绑定的服务唯一 ID。 */ ServiceId: string; /** API唯一ID数组，当bindType=API时，需要传入此参数。 */ ApiIds?: string[]; } declare interface BindEnvironmentResponse { /** 绑定操作是否成功。 */ Result: boolean | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface BindIPStrategyRequest { /** 待绑定的IP策略所属的服务唯一ID。 */ ServiceId: string; /** 待绑定的IP策略唯一ID。 */ StrategyId: string; /** IP策略待绑定的环境。 */ EnvironmentName: string; /** IP策略待绑定的API列表。 */ BindApiIds: string[]; } declare interface BindIPStrategyResponse { /** 绑定操作是否成功。 */ Result: boolean | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface BindSecretIdsRequest { /** 待绑定的使用计划唯一 ID。 */ UsagePlanId: string; /** 待绑定的密钥 ID 数组。 */ AccessKeyIds: string[]; } declare interface BindSecretIdsResponse { /** 绑定操作是否成功。 */ Result?: boolean | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface BindSubDomainRequest { /** 服务唯一 ID。 */ ServiceId: string; /** 待绑定的自定义的域名。 */ SubDomain: string; /** 服务支持协议，可选值为http、https、http&https。 */ Protocol: string; /** 网络类型，可选值为OUTER、INNER。 */ NetType: string; /** 是否使用默认路径映射，默认为 true。为 false 时，表示自定义路径映射，此时 PathMappingSet 必填。 */ IsDefaultMapping: boolean; /** 默认域名。 */ NetSubDomain: string; /** 待绑定自定义域名的证书唯一 ID。针对Protocol 为https或http&https可以选择上传。 */ CertificateId?: string; /** 自定义域名路径映射，最多输入三个Environment，并且只能分别取值“test”、 ”prepub“、”release“。 */ PathMappingSet?: PathMapping[]; /** 是否将HTTP请求强制跳转 HTTPS，默认为false。参数为 true时，API网关会将所有使用该自定义域名的 HTTP 协议的请求重定向至 HTTPS 协议进行转发。 */ IsForcedHttps?: boolean; } declare interface BindSubDomainResponse { /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface BuildAPIDocRequest { /** API文档ID */ ApiDocId: string; } declare interface BuildAPIDocResponse { /** 操作是否成功 */ Result: boolean; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateAPIDocRequest { /** API文档名称 */ ApiDocName: string; /** 服务名称 */ ServiceId: string; /** 环境名称 */ Environment: string; /** 生成文档的API列表 */ ApiIds: string[]; /** 标签 */ Tags?: Tag[]; } declare interface CreateAPIDocResponse { /** API文档基本信息 */ Result?: APIDoc; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateApiAppRequest { /** 用户自定义应用名称。 */ ApiAppName: string; /** 应用描述 */ ApiAppDesc?: string; } declare interface CreateApiAppResponse { /** 新增的应用详情。 */ Result?: ApiAppInfo | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateApiKeyRequest { /** 用户自定义密钥名称。 */ SecretName: string; /** 密钥类型，支持 auto 和 manual（自定义密钥），默认为 auto。 */ AccessKeyType?: string; /** 用户自定义密钥 ID，AccessKeyType 为 manual 时必传。长度为5 - 50字符，由字母、数字、英文下划线组成。 */ AccessKeyId?: string; /** 用户自定义密钥 Key，AccessKeyType 为 manual 时必传。长度为10 - 50字符，由字母、数字、英文下划线。 */ AccessKeySecret?: string; /** 标签 */ Tags?: Tag[]; } declare interface CreateApiKeyResponse { /** 新增的密钥详情。 */ Result?: ApiKey | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateApiRequest { /** API 所在的服务唯一 ID。 */ ServiceId: string; /** API 的后端服务类型。支持HTTP、MOCK、TSF、SCF、EB、TARGET、VPC、UPSTREAM、GRPC、COS、WEBSOCKET。 */ ServiceType: string; /** API 的后端服务超时时间，单位是秒。 */ ServiceTimeout: number; /** API 的前端请求协议，支持HTTP和WEBSOCKET。 */ Protocol: string; /** 请求的前端配置。 */ RequestConfig: ApiRequestConfig; /** 用户自定义的 API 名称。 */ ApiName?: string; /** 用户自定义的 API 接口描述。 */ ApiDesc?: string; /** API 类型，支持NORMAL（普通API）和TSF（微服务API），默认为NORMAL。 */ ApiType?: string; /** API 鉴权类型。支持SECRET（密钥对鉴权）、NONE（免鉴权）、OAUTH、APP（应用认证）。默认为NONE。 */ AuthType?: string; /** 是否开启跨域。 */ EnableCORS?: boolean; /** 常量参数。 */ ConstantParameters?: ConstantParameter[]; /** 前端请求参数。 */ RequestParameters?: RequestParameter[]; /** 当AuthType 为 OAUTH时，该字段有效， NORMAL：业务api OAUTH：授权API。 */ ApiBusinessType?: string; /** API 的后端 Mock 返回信息。如果 ServiceType 是 Mock，则此参数必传。 */ ServiceMockReturnMessage?: string; /** API绑定微服务列表。 */ MicroServices?: MicroServiceReq[]; /** 微服务的负载均衡配置。 */ ServiceTsfLoadBalanceConf?: TsfLoadBalanceConfResp; /** 微服务的健康检查配置。 */ ServiceTsfHealthCheckConf?: HealthCheckConf; /** target类型后端资源信息。（内测阶段） */ TargetServices?: TargetServicesReq[]; /** target类型负载均衡配置。（内测阶段） */ TargetServicesLoadBalanceConf?: number; /** target健康检查配置。（内测阶段） */ TargetServicesHealthCheckConf?: HealthCheckConf; /** scf 函数名称。当后端类型是SCF时生效。 */ ServiceScfFunctionName?: string; /** scf websocket注册函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketRegisterFunctionName?: string; /** scf websocket清理函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketCleanupFunctionName?: string; /** scf websocket传输函数。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketTransportFunctionName?: string; /** scf 函数命名空间。当后端类型是SCF时生效。 */ ServiceScfFunctionNamespace?: string; /** scf函数版本。当后端类型是SCF时生效。 */ ServiceScfFunctionQualifier?: string; /** scf websocket注册函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketRegisterFunctionNamespace?: string; /** scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketRegisterFunctionQualifier?: string; /** scf websocket传输函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketTransportFunctionNamespace?: string; /** scf websocket传输函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketTransportFunctionQualifier?: string; /** scf websocket清理函数命名空间。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketCleanupFunctionNamespace?: string; /** scf websocket清理函数版本。当前端类型是WEBSOCKET且后端类型是SCF时生效。 */ ServiceWebsocketCleanupFunctionQualifier?: string; /** 是否开启响应集成。当后端类型是SCF时生效。 */ ServiceScfIsIntegratedResponse?: boolean; /** 开始调试后计费。（云市场预留字段） */ IsDebugAfterCharge?: boolean; /** 是否删除自定义响应配置错误码，如果不传或者传 False，不删除，当传 True 时，则删除此 API 所有自定义响应配置错误码。 */ IsDeleteResponseErrorCodes?: boolean; /** 返回类型。 */ ResponseType?: string; /** 自定义响应配置成功响应示例。 */ ResponseSuccessExample?: string; /** 自定义响应配置失败响应示例。 */ ResponseFailExample?: string; /** API 的后端服务配置。 */ ServiceConfig?: ServiceConfig; /** 关联的授权API 唯一 ID，当AuthType为OAUTH且ApiBusinessType为NORMAL时生效。标示业务API绑定的oauth2.0授权API唯一ID。 */ AuthRelationApiId?: string; /** API的后端服务参数。 */ ServiceParameters?: ServiceParameter[]; /** oauth配置。当AuthType是OAUTH时生效。 */ OauthConfig?: OauthConfig; /** 用户自定义错误码配置。 */ ResponseErrorCodes?: ResponseErrorCodeReq[]; /** tsf serverless 命名空间ID。（内测中） */ TargetNamespaceId?: string; /** 用户类型。 */ UserType?: string; /** 是否打开Base64编码，只有后端是scf时才会生效。 */ IsBase64Encoded?: boolean; /** 事件总线ID。 */ EventBusId?: string; /** scf函数类型。当后端类型是SCF时生效。支持事件触发(EVENT)，http直通云函数(HTTP)。 */ ServiceScfFunctionType?: string; /** 是否开启SCF Event异步调用。 */ ServiceScfEventIsAsyncCall?: boolean; /** EIAM应用类型。 */ EIAMAppType?: string; /** EIAM应用认证类型，支持仅认证（AuthenticationOnly）、认证和鉴权（Authorization）。 */ EIAMAuthType?: string; /** EIAM应用Token 有效时间，单位为秒，默认为7200秒。 */ TokenTimeout?: number; /** EIAM应用ID。 */ EIAMAppId?: string; /** 资源的Owner */ Owner?: string; } declare interface CreateApiResponse { /** api信息 */ Result?: CreateApiResultInfo | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateExclusiveInstancesRequest { /** 可用区 */ Zones: string[]; /** 实例类型： basic：基础版professional：专业版enterprise：企业版platium：铂金版diamond：钻石版 */ InstanceType: string; /** 网络配置 */ NetworkConfig: InstanceNetworkConfig; /** VPC配置 */ VpcConfig: VpcConfig; /** 付费类型：POSTPAID：后付费PREPAID：预付费 */ PayMode: string; /** 实例名 */ InstanceName?: string; /** 实例描述 */ InstanceDescription?: string; /** 标签 */ Tags?: Tag[]; /** 预付费付费时长：单位是月 */ Period?: number; /** 预付费续费标志：NOTIFY_AND_MANUAL_RENEW 手动续费NOTIFY_AND_AUTO_RENEW 自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW 不续费 */ AutoRenewFlag?: string; } declare interface CreateExclusiveInstancesResponse { /** 实例ID */ Result?: string; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateIPStrategyRequest { /** 服务的唯一ID。 */ ServiceId: string; /** 用户自定义的策略名称。 */ StrategyName: string; /** 策略类型。支持WHITE（白名单）和BLACK（黑名单）。 */ StrategyType: string; /** 策略详情，多个ip 使用\n 分隔符分开。 */ StrategyData: string; } declare interface CreateIPStrategyResponse { /** 新建的IP策略详情。 */ Result?: IPStrategy | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreatePluginRequest { /** 用户自定义的插件名称。最长50个字符，最短2个字符，支持 a-z,A-Z,0-9,_, 必须字母开头，字母或者数字结尾。 */ PluginName: string; /** 插件类型。目前支持IPControl, TrafficControl, Cors, CustomReq, CustomAuth，Routing，TrafficControlByParameter, CircuitBreaker, ProxyCache。 */ PluginType: string; /** 插件定义语句，支持json。 */ PluginData: string; /** 插件描述，限定200字以内。 */ Description?: string; /** 标签 */ Tags?: Tag[]; } declare interface CreatePluginResponse { /** 新建的插件详情。 */ Result: Plugin; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateServiceRequest { /** 用户自定义的服务名称。 */ ServiceName: string; /** 服务的前端请求类型。如 http、https、http&https。 */ Protocol: string; /** 用户自定义的服务描述。 */ ServiceDesc?: string; /** 网络类型列表，用于指定支持的访问类型，INNER为内网访问，OUTER为外网访问。默认为OUTER。 */ NetTypes?: string[]; /** IP版本号，仅支持IPv4。 */ IpVersion?: string; /** 集群名称。保留字段，tsf serverless类型使用。 */ SetServerName?: string; /** 用户类型。保留类型，serverless用户使用。 */ AppIdType?: string; /** 标签。 */ Tags?: Tag[]; /** 独享实例id */ InstanceId?: string; /** vpc属性，选择VPC后不可修改，为服务选择VPC后，可对接该VPC下的后端资源 */ UniqVpcId?: string; } declare interface CreateServiceResponse { /** 服务唯一ID。 */ ServiceId?: string; /** 用户自定义服务名称。 */ ServiceName?: string; /** 用户自定义服务描述。 */ ServiceDesc?: string; /** 外网默认域名。 */ OuterSubDomain?: string; /** vpc内网默认域名。 */ InnerSubDomain?: string; /** 服务创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime?: string; /** 网络类型列表，INNER为内网访问，OUTER为外网访问。 */ NetTypes?: string[]; /** IP版本号。 */ IpVersion?: string | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateUpstreamRequest { /** 后端协议，取值范围：HTTP, HTTPS,gRPC，gRPCs */ Scheme: string; /** 负载均衡算法，取值范围：ROUND-ROBIN */ Algorithm: string; /** VPC唯一ID */ UniqVpcId: string; /** 后端通道名字 */ UpstreamName?: string; /** 后端通道描述 */ UpstreamDescription?: string; /** 后端访问类型，取值范围：IP_PORT, K8S */ UpstreamType?: string; /** 请求重试次数，默认3次 */ Retries?: number; /** 网关转发到后端的Host请求头 */ UpstreamHost?: string; /** 后端节点 */ Nodes?: UpstreamNode[]; /** 标签 */ Tags?: Tag[]; /** 健康检查配置，目前只支持VPC通道 */ HealthChecker?: UpstreamHealthChecker; /** K8S容器服务的配置 */ K8sService?: K8sService[]; } declare interface CreateUpstreamResponse { /** 创建返回的唯一ID */ UpstreamId?: string | null; /** 唯一请求 ID，每次请求都会返回。 */ RequestId?: string; } declare interface CreateUsagePlanRequest { /** 用户自定义的使用计划名称。 */ UsagePlanName: string; /** 用户自定义的使用计划描述。 */ UsagePlanDesc?: string; /** 请求配额总数，取值范围为-1或者[1, 99999999]，默认为-1，表示不开启。 */ MaxRequestNum?: number; /** 每秒请求限制数，取值范围为-1或者[1, 2000]，默认-1，表示不开启。 */ MaxRequestNumPreSec?: number