tencent cloud

All product documents
API Gateway
DocumentationAPI GatewayAPI DocumentationData Types
Data Types
Download PDF
Last updated: 2024-10-31 17:08:04
Data Types
Last updated: 2024-10-31 17:08:04
Download PDF

APIDoc

Basic information of API document

Used by actions: CreateAPIDoc, DescribeAPIDocs, ModifyAPIDoc, ResetAPIDocPassword.

Name Type Description
ApiDocId String API document ID
ApiDocName String API document name
ApiDocStatus String API document build status

APIDocInfo

API document details

Used by actions: DescribeAPIDocDetail.

Name Type Description
ApiDocId String API document ID
ApiDocName String API document name
ApiDocStatus String API document build status
ApiCount Integer Number of APIs with API documents
ViewCount Integer Number of views of API document
ReleaseCount Integer Number of releases of API document
ApiDocUri String API document access URI
SharePassword String API document password for sharing
UpdatedTime Timestamp API document update time
ServiceId String Service ID
Environment String Environment information
ApiIds Array of String ID of the API for which to generate the API document
ServiceName String Service name
ApiNames Array of String Name of the API for which to generate the API document

APIDocs

API document list

Used by actions: DescribeAPIDocs.

Name Type Description
TotalCount Integer Number of API documents
APIDocSet Array of APIDoc Basic information of API document

ApiAppApiInfo

Information of the API bound to the application

Used by actions: DescribeApiAppBindApisStatus, DescribeApiBindApiAppsStatus.

Name Type Description
ApiAppName String Application name
Note: this field may return null, indicating that no valid values can be obtained.
ApiAppId String Application ID
ApiId String API ID
Note: this field may return null, indicating that no valid values can be obtained.
ApiName String API name
Note: this field may return null, indicating that no valid values can be obtained.
ServiceId String Service ID
Note: this field may return null, indicating that no valid values can be obtained.
AuthorizedTime Timestamp ISO8601 Binding authorization time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ApiRegion String API region
Note: this field may return null, indicating that no valid values can be obtained.
EnvironmentName String Authorized binding environment
Note: this field may return null, indicating that no valid values can be obtained.

ApiAppApiInfos

Application information set

Used by actions: DescribeApiAppBindApisStatus, DescribeApiBindApiAppsStatus.

Name Type Description
TotalCount Integer Quantity
ApiAppApiSet Array of ApiAppApiInfo Information array of the API bound to the application
Note: this field may return null, indicating that no valid values can be obtained.

ApiAppInfo

Application information

Used by actions: CreateApiApp, DescribeApiApp, DescribeApiAppsStatus.

Name Type Description
ApiAppName String Application name
Note: this field may return null, indicating that no valid values can be obtained.
ApiAppId String Application ID
ApiAppSecret String Application SECRET
Note: this field may return null, indicating that no valid values can be obtained.
ApiAppDesc String Application description
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Modification time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ApiAppKey String Application KEY
Note: this field may return null, indicating that no valid values can be obtained.

ApiAppInfos

Application information set

Used by actions: DescribeApiApp, DescribeApiAppsStatus.

Name Type Description
TotalCount Integer Number of applications
ApiAppSet Array of ApiAppInfo Application information array
Note: this field may return null, indicating that no valid values can be obtained.

ApiEnvironmentStrategy

API environment binding policy

Used by actions: DescribeApiEnvironmentStrategy.

Name Type Description
ApiId String Unique API ID.
ApiName String Custom API name.
Path String API path, such as /path.
Method String API method, such as GET.
EnvironmentStrategySet Array of EnvironmentStrategy Environment throttling information.

ApiEnvironmentStrategyStatus

Used by actions: DescribeApiEnvironmentStrategy.

Name Type Description
TotalCount Integer
ApiEnvironmentStrategySet Array of ApiEnvironmentStrategy

ApiIdStatus

API status

Used by actions: DescribeService, DescribeServiceForApiApp.

Name Type Description
ServiceId String Unique service ID.
ApiId String Unique API ID.
ApiDesc String API description
Note: This field may return null, indicating that no valid values can be obtained.
Path String API path.
Method String API method.
CreatedTime Timestamp ISO8601 Service creation time.
ModifiedTime Timestamp ISO8601 Service modification time.
ApiName String API name.
Note: this field may return null, indicating that no valid values can be obtained.
UniqVpcId String Unique VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
ApiType String API type.
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String API protocol.
Note: this field may return null, indicating that no valid values can be obtained.
IsDebugAfterCharge Boolean Whether to enable debugging after purchase.
Note: this field may return null, indicating that no valid values can be obtained.
AuthType String Authorization type.
Note: this field may return null, indicating that no valid values can be obtained.
ApiBusinessType String API business type.
Note: this field may return null, indicating that no valid values can be obtained.
AuthRelationApiId String Unique ID of associated authorization API.
Note: this field may return null, indicating that no valid values can be obtained.
OauthConfig OauthConfig OAuth configuration information.
Note: this field may return null, indicating that no valid values can be obtained.
TokenLocation String Token storage position, which is an OAuth 2.0 API request.
Note: this field may return null, indicating that no valid values can be obtained.

ApiInfo

API information

Used by actions: DescribeApi, DescribeApiForApiApp.

Name Type Description
ServiceId String Unique service ID of API.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceName String Service name of API.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceDesc String Service description of API.
Note: this field may return null, indicating that no valid values can be obtained.
ApiId String Unique API ID.
Note: this field may return null, indicating that no valid values can be obtained.
ApiDesc String API description.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ApiName String API name.
Note: this field may return null, indicating that no valid values can be obtained.
ApiType String API type. Valid values: NORMAL (general API), TSF (microservice API).
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
Note: this field may return null, indicating that no valid values can be obtained.
AuthType String API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH.
Note: this field may return null, indicating that no valid values can be obtained.
ApiBusinessType String OAuth API type. Valid values: NORMAL (business API), OAUTH (authorization API).
Note: this field may return null, indicating that no valid values can be obtained.
AuthRelationApiId String Unique ID of the authorization API associated with OAuth business API.
Note: this field may return null, indicating that no valid values can be obtained.
OauthConfig OauthConfig OAuth configuration.
Note: this field may return null, indicating that no valid values can be obtained.
IsDebugAfterCharge Boolean Whether to enable debugging after purchase (reserved field for the marketplace).
Note: this field may return null, indicating that no valid values can be obtained.
RequestConfig RequestConfig Request frontend configuration.
Note: this field may return null, indicating that no valid values can be obtained.
ResponseType String Return type.
Note: this field may return null, indicating that no valid values can be obtained.
ResponseSuccessExample String Sample response for successful custom response configuration.
Note: this field may return null, indicating that no valid values can be obtained.
ResponseFailExample String Sample response for failed custom response configuration.
Note: this field may return null, indicating that no valid values can be obtained.
ResponseErrorCodes Array of ErrorCodes Custom error code configuration.
Note: this field may return null, indicating that no valid values can be obtained.
RequestParameters Array of ReqParameter Frontend request parameter.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceTimeout Integer API backend service timeout period in seconds.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceType String API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
Note: this field may return null, indicating that no valid values can be obtained.
ServiceConfig ServiceConfig API backend service configuration.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceParameters Array of DescribeApiResultServiceParametersInfo API backend service parameter.
Note: this field may return null, indicating that no valid values can be obtained.
ConstantParameters Array of ConstantParameter Constant parameter.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceMockReturnMessage String Returned message of API backend Mock, which is required if ServiceType is Mock.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceScfFunctionName String SCF function name, which takes effect if the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceScfFunctionNamespace String SCF function namespace, which takes effect if the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceScfFunctionQualifier String SCF function version, which takes effect if the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceScfIsIntegratedResponse Boolean Whether integrated response is enabled.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketRegisterFunctionName String SCF WebSocket registration function namespace, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketRegisterFunctionNamespace String SCF WebSocket registration function namespace, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketRegisterFunctionQualifier String SCF WebSocket transfer function version, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketCleanupFunctionName String SCF WebSocket cleanup function, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketCleanupFunctionNamespace String SCF WebSocket cleanup function namespace, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketCleanupFunctionQualifier String SCF WebSocket cleanup function version, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
InternalDomain String WebSocket callback address.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketTransportFunctionName String SCF WebSocket transfer function, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketTransportFunctionNamespace String SCF WebSocket transfer function namespace, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceWebsocketTransportFunctionQualifier String SCF WebSocket transfer function version, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
Note: this field may return null, indicating that no valid values can be obtained.
MicroServices Array of MicroService List of microservices bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
MicroServicesInfo Array of Integer Microservice details.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceTsfLoadBalanceConf TsfLoadBalanceConfResp Load balancing configuration of microservice.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceTsfHealthCheckConf HealthCheckConf Health check configuration of microservice.
Note: this field may return null, indicating that no valid values can be obtained.
EnableCORS Boolean Whether to enable CORS.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Information of tags bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
Environments Array of String Environment information published for API.
Note: this field may return null, indicating that no valid values can be obtained.
IsBase64Encoded Boolean Whether to enable Base64 encoding. This parameter takes effect only when the backend is SCF.
Note: This field may return null, indicating that no valid values can be obtained.
IsBase64Trigger Boolean Whether to trigger Base64 encoding by header. This parameter takes effect only when the backend is SCF.
Note: This field may return null, indicating that no valid values can be obtained.
Base64EncodedTriggerRules Array of Base64EncodedTriggerRule Header trigger rules. The number of rules cannot exceed 10.
Note: This field may return null, indicating that no valid values can be obtained.

ApiInfoSummary

Information of the APIs that can use this plugin

Used by actions: DescribeAllPluginApis.

Name Type Description
TotalCount Integer Total number of APIs that can use this plugin
ApiSet Array of AvailableApiInfo Information of the APIs that can use this plugin

ApiKey

Key details

Used by actions: CreateApiKey, DescribeApiKey, DescribeApiKeysStatus, UpdateApiKey.

Name Type Description
AccessKeyId String Created API key ID.
AccessKeySecret String Created API key.
AccessKeyType String Key type. Valid values: auto, manual.
SecretName String Custom key name.
ModifiedTime Timestamp ISO8601 Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Status Integer Key status. 0: disabled. 1: enabled.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.

ApiKeysStatus

Key list

Used by actions: DescribeApiKeysStatus.

Name Type Description
TotalCount Integer Number of eligible API keys.
Note: this field may return null, indicating that no valid values can be obtained.
ApiKeySet Array of ApiKey API key list.
Note: this field may return null, indicating that no valid values can be obtained.

ApiRequestConfig

API request configuration

Used by actions: CreateApi.

Name Type Required Description
Path String Yes path
Method String Yes Method

ApiUsagePlan

Details of usage plans bound to API or service

Used by actions: DescribeApiUsagePlan, DescribeServiceUsagePlan.

Name Type Description
ServiceId String Unique service ID.
Note: this field may return null, indicating that no valid values can be obtained.
ApiId String Unique API ID.
Note: this field may return null, indicating that no valid values can be obtained.
ApiName String API name.
Note: this field may return null, indicating that no valid values can be obtained.
Path String API path.
Note: this field may return null, indicating that no valid values can be obtained.
Method String API method.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanId String Unique usage plan ID.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanName String Usage plan name.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanDesc String Usage plan description.
Note: this field may return null, indicating that no valid values can be obtained.
Environment String Service environment bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
InUseRequestNum Integer Used quota.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNum Integer Total number of requests allowed. -1 indicates no limit.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNumPreSec Integer Request QPS upper limit. -1 indicates no limit.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Usage plan creation time.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modified time of usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceName String Service name.
Note: this field may return null, indicating that no valid values can be obtained.

ApiUsagePlanSet

List of usage plans bound to API

Used by actions: DescribeApiUsagePlan.

Name Type Description
TotalCount Integer Total number of usage plans bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
ApiUsagePlanList Array of ApiUsagePlan List of usage plans bound to API.
Note: this field may return null, indicating that no valid values can be obtained.

ApigatewayTags

key-value

Used by actions: DescribeApisStatus.

Name Type Description

AttachedApiInfo

Information of the API bound with the plugin

Used by actions: CreatePlugin, DescribePlugin, DescribePluginApis.

Name Type Description
ServiceId String ID of the service to which the API belongs
ServiceName String Name of the service to which the API belongs
ServiceDesc String Description of the service to which the API belongs
Note: this field may return null, indicating that no valid values can be obtained.
ApiId String API ID
ApiName String API name
ApiDesc String API description
Note: this field may return null, indicating that no valid values can be obtained.
Environment String Environment of the API bound with the plugin
AttachedTime Timestamp ISO8601 Time when the plugin was bound to the API

AttachedApiSummary

List of APIs bound with the plugin

Used by actions: DescribePluginApis.

Name Type Description
TotalCount Integer Number of APIs bound with the plugin
AttachedApis Array of AttachedApiInfo Information of the API bound with the plugin

AttachedPluginInfo

Information of bound plug-ins

Used by actions: DescribePluginsByApi.

Name Type Description
PluginId String Plugin ID
Environment String Environment information
AttachedTime String Binding time
PluginName String Plugin name
PluginType String Plugin type
Description String Plugin description
PluginData String Plugin definition statement

AttachedPluginSummary

Information of bound plug-ins

Used by actions: DescribePluginsByApi.

Name Type Description
TotalCount Integer Total number of bound plug-ins
PluginSummary Array of AttachedPluginInfo Information of bound plug-ins

AvailableApiInfo

Information of the APIs that can use this plugin

Used by actions: DescribeAllPluginApis.

Name Type Description
ApiId String API ID
ApiName String API name
ApiType String API type
Path String API path
Method String API method
AttachedOtherPlugin Boolean Whether the API is bound with another plugin
Note: this field may return null, indicating that no valid values can be obtained.
IsAttached Boolean Whether the API is bound with the current plugin
Note: this field may return null, indicating that no valid values can be obtained.

Base64EncodedTriggerRule

Header trigger rule for Base64 encoding.

Used by actions: DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
Name String Yes Header for triggering encoding. Valid values are Accept and Content_Type, corresponding to the Accept and Content-Type headers in the data stream request, respectively.
Value Array of String Yes Array of header values that can trigger the encoding. Each element in the array can be up to 40 characters, including digits, letters, and special characters (., +, *, -, /, and _).

For example, [
"application/x-vpeg005",
"application/xhtml+xml",
"application/vnd.ms-project",
"application/vnd.rn-rn_music_package"
] are valid.

BindApiInfo

Information of the API bound with the upstream

Used by actions: DescribeUpstreamBindApis.

Name Type Description
ApiId String Unique API ID.
ServiceId String Unique ID of the service
ApiName String API name
Note: This field may return null, indicating that no valid value was found.
ServiceName String Service name
Note: This field may return null, indicating that no valid value was found.
BindTime Timestamp ISO8601 Bound At

ConstantParameter

Constant parameter

Used by actions: CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
Name String No Constant parameter name This is only applicable when ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.
Desc String No Constant parameter description This is only applicable when ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.
Position String No Constant paramter location This is only applicable when ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.
DefaultValue String No Default value of the constant parameter This is only applicable when ServiceType is HTTP.
Note: This field may return null, indicating that no valid values can be obtained.

CosConfig

COS-type API configuration

Used by actions: CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
Action String Yes Specifies how the backend COS bucket is called by the API. The frontend request method and Action can be:
GET：GetObject
PUT：PutObject
POST：PostObject、AppendObject
HEAD： HeadObject
DELETE： DeleteObject
Note: this field may return null, indicating that no valid values can be obtained.
BucketName String Yes Backend COS bucket of the API
Note: this field may return null, indicating that no valid values can be obtained.
Authorization Boolean No Whether to enable the backend COS signature for the API. It defaults to false.
Note: this field may return null, indicating that no valid values can be obtained.
PathMatchMode String No The path matching mode of the backend COS service
BackEndPath: Match the backend path
FullPath: Match the full path

Default: BackEndPath
Note: This field may return null, indicating that no valid values can be obtained.

CreateApiResultInfo

Response of API creation

Used by actions: CreateApi.

Name Type Description
ApiId String API ID
Note: this field may return null, indicating that no valid values can be obtained.
Path String Path
Note: this field may return null, indicating that no valid values can be obtained.
Method String Request method
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time
Note: this field may return null, indicating that no valid values can be obtained.

CreateApiRsp

Return of API creation

Used by actions: ImportOpenApi.

Name Type Description
ApiId String API ID
Note: this field may return null, indicating that no valid values can be obtained.
Path String Path
Note: This field may return null, indicating that no valid values can be obtained.
Method String Request method
Note: This field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time
Note: this field may return null, indicating that no valid values can be obtained.
Status String Status of the import task
Note: This field may return null, indicating that no valid values can be obtained.
ErrMsg String Details of the error
Note: This field may return null, indicating that no valid values can be obtained.
ApiName String API name
Note: This field may return null, indicating that no valid values can be obtained.

CreateApiRspSet

Information of the APIs created

Used by actions: ImportOpenApi.

Name Type Description
TotalCount Integer Total number of APIs
ApiSet Array of CreateApiRsp Information of created APIs

DesApisStatus

API status details

Used by actions: CreateIPStrategy, DescribeIPStrategy.

Name Type Description
ServiceId String Unique service ID.
ApiId String Unique API ID.
ApiDesc String Custom API description.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ApiName String API name.
Note: this field may return null, indicating that no valid values can be obtained.
VpcId Integer VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
UniqVpcId String Unique VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
ApiType String API type. Valid values: NORMAL (general API), TSF (microservice API).
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String API protocol.
Note: this field may return null, indicating that no valid values can be obtained.
IsDebugAfterCharge Boolean Whether to enable debugging after purchase (reserved field for the marketplace)
Note: this field may return null, indicating that no valid values can be obtained.
AuthType String API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH, and EIAM
Note: this field may return null, indicating that no valid values can be obtained.
ApiBusinessType String OAuth API type, which is valid if AuthType is OAUTH. Valid values: NORMAL (business API), OAUTH (authorization API).
Note: this field may return null, indicating that no valid values can be obtained.
AuthRelationApiId String Unique ID of associated authorization API, which takes effect only if AuthType is OAUTH and ApiBusinessType is NORMAL. It is the unique ID of the OAuth 2.0 authorization API bound to the business API.
Note: this field may return null, indicating that no valid values can be obtained.
OauthConfig OauthConfig OAuth configuration information, which takes effect if AuthType is OAUTH.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of String Information of tags associated with API.
Note: this field may return null, indicating that no valid values can be obtained.
Path String API path, such as /path.
Note: this field may return null, indicating that no valid values can be obtained.
Method String API request method, such as GET.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeApiResultServiceParametersInfo

ServiceParameter

Used by actions: DescribeApi, DescribeApiForApiApp.

Name Type Required Description
Name String No API backend service parameter name. This is only applicable when ServiceType is HTTP. Names of frontend and backend parameters can be different.
Note: This field may return null, indicating that no valid values can be obtained.
Position String No Location of the API backend service parameter, such as head This is only applicable when ServiceType is HTTP. Configurations of frontend and backend parameters can be different.
Note: this field may return null, indicating that no valid values can be obtained.
RelevantRequestParameterPosition String No Location of the frontend parameter corresponding to the API backend service parameter, such as head This is only applicable when ServiceType is HTTP.
Note: This field may return null, indicating that no valid values can be obtained.
RelevantRequestParameterName String No Name of the frontend parameter corresponding to the API backend service parameter. This is only applicable when ServiceType is HTTP.
Note: This field may return null, indicating that no valid values can be obtained.
DefaultValue String No Default value of API backend service parameter. This is only applicable when ServiceType is HTTP.
Note: This field may return null, indicating that no valid values can be obtained.
RelevantRequestParameterDesc String No Description of API backend service parameter. This is only applicable when ServiceType is HTTP.
Note: This field may return null, indicating that no valid values can be obtained.

DescribeApisStatusResultApiIdStatusSetInfo

API status details

Used by actions: DescribeApisStatus.

Name Type Description
ServiceId String Unique service ID.
ApiId String Unique API ID.
ApiDesc String Custom API description.
Note: This field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time. u200dIt is the UTC time in ISO-8601 format. Format: YYYY-MM-DDThh:mm:ssZ.
Note: This field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modification time u200dIt is the UTC time in ISO-8601 format. Format: YYYY-MM-DDThh:mm:ssZ.
Note: u200dThis field may return null, indicating that no valid values can be obtained.
ApiName String API name.
Note: This field may return null, indicating that no valid values can be obtained.
VpcId Integer VPC ID
Note: This field may return null, indicating that no valid values can be obtained.
UniqVpcId String Unique VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
ApiType String API type API type. Valid values: NORMAL (general API), TSF (microservice API).
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String API protocol.
Note: This field may return null, indicating that no valid values can be obtained.
IsDebugAfterCharge Boolean Whether to enable debugging after purchase. (This field is reserved for Marketplace
Note: This field may return null, indicating that no valid values can be obtained.
AuthType String API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH, and EIAM.
Note: This field may return null, indicating that no valid values can be obtained.
ApiBusinessType String OAuth API type. Valid values: u200dNORMAL (service API), OAUTH (authorization API). It is only applicable when AuthType is OAUTH.
Note: This field may return null, indicating that no valid values can be obtained.
AuthRelationApiId String Unique ID of associated authorization API. It is applicable when AuthType is OAUTH and ApiBusinessType is NORMAL. It is the unique ID of the OAuth 2.0 authorization API bound to the service API.
Note: This field may return null, indicating that no valid values can be obtained.
OauthConfig OauthConfig OAUTH configuration information. It is applicable when AuthType is OAUTH.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of ApigatewayTags Information of tags associated with API.
Note: this field may return null, indicating that no valid values can be obtained.
Path String API path, such as /path.
Note: this field may return null, indicating that no valid values can be obtained.
Method String API request method, such as GET.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeApisStatusResultInfo

API list status description

Used by actions: DescribeApisStatus.

Name Type Description
TotalCount Integer Number of eligible APIs.
ApiIdStatusSet Array of DescribeApisStatusResultApiIdStatusSetInfo List of APIs

DescribeServiceReleaseVersionResultVersionListInfo

Service version details

Used by actions: DescribeServiceReleaseVersion.

Name Type Description
VersionName String Version ID.
Note: This field may return null, indicating that no valid values can be obtained.
VersionDesc String Version description.
Note: this field may return null, indicating that no valid values can be obtained.

DescribeUpstreamBindApis

Queries APIs bound with an upstream

Used by actions: DescribeUpstreamBindApis.

Name Type Description
TotalCount Integer Total number
BindApiSet Array of BindApiInfo Information of bound APIs

DescribeUpstreamInfo

The returned result of upstream query

Used by actions: DescribeUpstreams.

Name Type Description
TotalCount Integer Total number of results
UpstreamSet Array of UpstreamInfo List of query result

DomainSetList

Custom service domain name list

Used by actions: DescribeServiceSubDomains.

Name Type Description
DomainName String Domain name.
Status Integer Domain name resolution status. 1: normal, 0: failed
CertificateId String Certificate ID.
IsDefaultMapping Boolean Whether the default path mapping is used.
Protocol String Custom domain name protocol type.
NetType String Network type. Valid values: INNER, OUTER.
IsForcedHttps Boolean Whether to force HTTP requests to redirect to HTTPS. Default value: false. When this parameter is true, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding.
RegistrationStatus Boolean ICP filing status

DomainSets

Custom service domain name information

Used by actions: DescribeServiceSubDomains.

Name Type Description
TotalCount Integer Number of custom domain names under service
DomainSet Array of DomainSetList Custom service domain name list.

Environment

Information of service release environment.

Used by actions: DescribeServiceEnvironmentList.

Name Type Description
EnvironmentName String Environment name.
Url String Access path.
Status Integer Release status. 1: published. 0: not published.
VersionName String Running version.

EnvironmentStrategy

Environment throttling

Used by actions: DescribeApiEnvironmentStrategy.

Name Type Description
EnvironmentName String Environment name
Quota Integer Throttling value

ErrorCodes

Custom error code

Used by actions: DescribeApi, DescribeApiForApiApp.

Name Type Required Description
Code Integer No Custom response configuration error code.
Note: this field may return null, indicating that no valid values can be obtained.
Msg String No Custom response configuration error message.
Note: this field may return null, indicating that no valid values can be obtained.
Desc String No Custom response configuration error code remarks.
Note: this field may return null, indicating that no valid values can be obtained.
ConvertedCode Integer No Custom error code conversion.
Note: this field may return null, indicating that no valid values can be obtained.
NeedConvert Boolean No Whether to enable error code conversion.
Note: this field may return null, indicating that no valid values can be obtained.

Filter

Key-value pair filter for conditional filtering queries, such as filtering ID, name, status, etc.

  • If there are multiple Filter, the relationship among them is logical AND.
  • If there are multiple Values in the same Filter, the relationship among them is logical OR.

Used by actions: DescribeApiAppBindApisStatus, DescribeApiAppsStatus, DescribeApiBindApiAppsStatus, DescribeApiKeysStatus, DescribeApisStatus, DescribeIPStrategy, DescribeIPStrategyApisStatus, DescribeIPStrategysStatus, DescribeLogSearch, DescribeServicesStatus, DescribeUpstreamBindApis, DescribeUpstreams, DescribeUsagePlansStatus.

Name Type Required Description
Name String Yes Field to be filtered.
Values Array of String Yes Filter value of field.

HealthCheckConf

Health check configuration, including TsfHealthCheckConf and TargetServicesHealthCheckConf

Used by actions: CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
IsHealthCheck Boolean No Whether health check is enabled.
Note: This field may return null, indicating that no valid values can be obtained.
RequestVolumeThreshold Integer No Health check threshold.
Note: This field may return null, indicating that no valid values can be obtained.
SleepWindowInMilliseconds Integer No Window size.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorThresholdPercentage Integer No Threshold percentage.
Note: This field may return null, indicating that no valid values can be obtained.

IPStrategiesStatus

Used by actions: DescribeIPStrategysStatus.

Name Type Description
TotalCount Integer
StrategySet Array of IPStrategy

IPStrategy

IP policy

Used by actions: CreateIPStrategy, DescribeIPStrategy, DescribeIPStrategysStatus.

Name Type Description
StrategyId String Unique policy ID.
Note: this field may return null, indicating that no valid values can be obtained.
StrategyName String Custom policy name.
Note: this field may return null, indicating that no valid values can be obtained.
StrategyType String Policy type. Valid values: WHITE (allowlist), BLACK (blocklist).
Note: this field may return null, indicating that no valid values can be obtained.
StrategyData String IP list.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Modification time
Note: this field may return null, indicating that no valid values can be obtained.
ServiceId String Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
BindApiTotalCount Integer Number of APIs bound to policy.
Note: this field may return null, indicating that no valid values can be obtained.
BindApis Array of DesApisStatus Bound API details.
Note: this field may return null, indicating that no valid values can be obtained.

IPStrategyApi

List of APIs bound to policy

Used by actions: DescribeIPStrategyApisStatus.

Name Type Description
ApiId String Unique API ID.
ApiName String Custom API name.
ApiType String API type. Valid values: NORMAL (general API), TSF (microservice API).
Path String API path, such as /path.
Method String API request method, such as GET.
OtherIPStrategyId String Unique ID of another policy bound to API.
OtherEnvironmentName String Environment bound to API.

IPStrategyApiStatus

Details of API bound to IP policy

Used by actions: DescribeIPStrategyApisStatus.

Name Type Description
TotalCount Integer Number of APIs bound to environment.
Note: this field may return null, indicating that no valid values can be obtained.
ApiIdStatusSet Array of IPStrategyApi Details of APIs bound to environment.
Note: this field may return null, indicating that no valid values can be obtained.

K8sLabel

K8s Label

Used by actions: CreateUpstream, ModifyUpstream.

Name Type Required Description
Key String Yes Key of the label
Value String Yes Value of the label

K8sService

Configuration of K8s service

Used by actions: CreateUpstream, DescribeUpstreams, ModifyUpstream.

Name Type Required Description
Weight Integer Yes Weight
ClusterId String Yes K8s cluster ID
Namespace String Yes Namespace of the container
ServiceName String Yes Name of the service
Port Integer Yes Service port
ExtraLabels Array of K8sLabel Yes The additional Label of the Pod
Name String No (Optional) Custom name of the service

MicroService

Information of microservice bound to API.

Used by actions: DescribeApi, DescribeApiForApiApp.

Name Type Required Description
ClusterId String No Microservice cluster ID.
NamespaceId String No Microservice namespace ID.
MicroServiceName String No Microservice name.

MicroServiceReq

TSF type input parameters

Used by actions: CreateApi, ModifyApi.

Name Type Required Description
ClusterId String Yes Microservice cluster.
NamespaceId String Yes Microservice namespace.
MicroServiceName String Yes Microservice name.

ModifyUpstreamResultInfo

Upstream details

Used by actions: ModifyUpstream.

Name Type Description
UpstreamId String Unique upstream ID
UpstreamName String Upstream name
UpstreamDescription String Upstream description
Scheme String Backend protocol. Valid values: HTTP, HTTPS
Algorithm String Load balancing algorithm. Valid value: ROUND_ROBIN
UniqVpcId String Unique VPC ID
Retries Integer Number of retry attempts
Nodes Array of UpstreamNode Backend nodes
CreatedTime Timestamp ISO8601 Creation time
HealthChecker UpstreamHealthChecker Health check configuration
Note: This field may return null, indicating that no valid values can be obtained.
UpstreamType String Upstream type. Valid values: IP_PORT, K8S
K8sServices Array of K8sService Configuration of TKE service
Note: This field may return null, indicating that no valid values can be obtained.
UpstreamHost String The Host header that the gateway forwards to the upstream
Note: This field may return null, indicating that no valid values can be obtained.

OauthConfig

OAuth authorization configuration information

Used by actions: CreateApi, CreateIPStrategy, DescribeApi, DescribeApiForApiApp, DescribeApisStatus, DescribeIPStrategy, DescribeService, DescribeServiceForApiApp, ModifyApi.

Name Type Required Description
PublicKey String Yes Public key for user token verification.
TokenLocation String Yes Token delivery location.
LoginRedirectUrl String No Redirect address, which is used to guide user logins.

PathMapping

Custom domain name path mapping.

Used by actions: BindSubDomain, DescribeServiceSubDomainMappings, ModifySubDomain.

Name Type Required Description
Path String Yes Path.
Environment String Yes Release environment. Valid values: test, prepub, release.

Plugin

Details of the API Gateway plugin

Used by actions: CreatePlugin, DescribePlugin.

Name Type Description
PluginId String Plugin ID
PluginName String Plugin name
PluginType String Plugin type
PluginData String Plugin definition statement
Description String Plugin description
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Plugin creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
ModifiedTime Timestamp ISO8601 Plugin modification time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used
AttachedApiTotalCount Integer Total number of APIs bound with the plugin
Note: this field may return null, indicating that no valid values can be obtained.
AttachedApis Array of AttachedApiInfo Information of the API bound with the plugin
Note: this field may return null, indicating that no valid values can be obtained.

ReleaseService

Returned result of service publishing

Used by actions: ReleaseService.

Name Type Description
ReleaseDesc String Release remarks.
Note: this field may return null, indicating that no valid values can be obtained.
ReleaseVersion String Published version ID.
Note: this field may return null, indicating that no valid values can be obtained.

ReqParameter

Request parameter

Used by actions: DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
Name String Yes API frontend parameter name.
Position String Yes Position of the API frontend parameter, such as the header. Supported values: header, query, and path.
Type String Yes API frontend parameter type, such as String and int.
DefaultValue String Yes Default value of API frontend parameter.
Required Boolean Yes Whether the API frontend parameter is required. True: yes; False: no.
Desc String Yes API frontend parameter remarks.

RequestConfig

Frontend path configuration

Used by actions: DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
Path String Yes API path, such as /path.
Method String Yes API request method, such as GET.

RequestParameter

Request parameter

Used by actions: CreateApi.

Name Type Required Description
Name String No Request parameter name
Desc String No Description
Position String No Parameter position
Type String No Parameter type
DefaultValue String No Default value
Required Boolean No Whether it is required

ResponseErrorCodeReq

Error code input parameter

Used by actions: CreateApi, ModifyApi.

Name Type Required Description
Code Integer No Custom response configuration error code.
Msg String No Custom response configuration error message.
Desc String No Custom response configuration error code remarks.
ConvertedCode Integer No Custom error code conversion.
NeedConvert Boolean No Whether to enable error code conversion.

Service

Service list display

Used by actions: DescribeServicesStatus.

Name Type Description
InnerHttpsPort Integer Port for HTTPS access over private network.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceDesc String Custom service description.
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Service frontend request type, such as http, https, and http&https.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
NetTypes Array of String Network types supported by service.
Note: this field may return null, indicating that no valid values can be obtained.
ExclusiveSetName String Dedicated cluster name.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceId String Unique service ID.
Note: this field may return null, indicating that no valid values can be obtained.
IpVersion String IP version.
Note: this field may return null, indicating that no valid values can be obtained.
AvailableEnvironments Array of String List of published environments, such as test, prepub, and release.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceName String Custom service name.
Note: this field may return null, indicating that no valid values can be obtained.
OuterSubDomain String Public domain name assigned by the system for this service.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
InnerHttpPort Integer Port for HTTP access over private network.
Note: this field may return null, indicating that no valid values can be obtained.
InnerSubDomain String Private domain name automatically assigned by the system for this service.
Note: this field may return null, indicating that no valid values can be obtained.
TradeIsolateStatus Integer Billing status of service.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Tags bound to a service.
Note: this field may return null, indicating that no valid values found.
InstanceId String Dedicated instance
Note: this field may return null, indicating that no valid values can be obtained.
SetType String Cluster type
Note: this field may return null, indicating that no valid values can be obtained.
DeploymentType String Cluster type for service deployment
Note: this field may return null, indicating that no valid values found.

ServiceConfig

ServiceConfig information

Used by actions: CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
Product String No The backend type. It’s available when vpc is enabled. Values: clb, cvm and upstream.
UniqVpcId String No Unique VPC ID.
Url String No API backend service URL, which is required if ServiceType is HTTP.
Path String No API backend service path, such as /path, which is required if ServiceType is HTTP. The frontend and backend paths can be different.
Method String No API backend service request method, such as GET, which is required if ServiceType is HTTP. The frontend and backend methods can be different
UpstreamId String No It’s required for upstream.
Note: This field may return NULL, indicating that no valid value was found.
CosConfig CosConfig No API backend COS configuration. It’s required if the ServiceType is ·COS.
Note: this field may return null, indicating that no valid values can be obtained.

ServiceEnvironmentSet

Details of environments bound to service

Used by actions: DescribeServiceEnvironmentList.

Name Type Description
TotalCount Integer Total number of environments bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
EnvironmentList Array of Environment List of environments bound to service.
Note: this field may return null, indicating that no valid values can be obtained.

ServiceEnvironmentStrategy

Service environment policy

Used by actions: DescribeServiceEnvironmentStrategy.

Name Type Description
EnvironmentName String Environment name.
Url String Access service environment URL.
Status Integer Release status.
VersionName String Published version number.
Note: this field may return null, indicating that no valid values can be obtained.
Strategy Integer Throttling value.
MaxStrategy Integer Maximum quota value
Note: this field may return null, indicating that no valid values can be obtained.

ServiceEnvironmentStrategyStatus

List of policies bound to environment

Used by actions: DescribeServiceEnvironmentStrategy.

Name Type Description
TotalCount Integer Number of throttling policies.
Note: this field may return null, indicating that no valid values can be obtained.
EnvironmentList Array of ServiceEnvironmentStrategy Throttling policy list.
Note: this field may return null, indicating that no valid values can be obtained.

ServiceParameter

ServiceParameter

Used by actions: CreateApi, ModifyApi.

Name Type Required Description
Name String No API backend service parameter name, which is used only if ServiceType is HTTP. The frontend and backend parameter names can be different.
Note: this field may return null, indicating that no valid values can be obtained.
Position String No Position of API backend service parameter, such as head, which is used only if ServiceType is HTTP. The positions of frontend and backend parameters can be different.
Note: this field may return null, indicating that no valid values can be obtained.
RelevantRequestParameterPosition String No Position of the API frontend parameter corresponding to the backend service parameter, such as head, which is used only if ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.
RelevantRequestParameterName String No Name of the API frontend parameter corresponding to the backend service parameter, which is used only if ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.
DefaultValue String No Default value of API backend service parameter, which is used only if ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.
RelevantRequestParameterDesc String No API backend service parameter remarks, which is used only if ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.
RelevantRequestParameterType String No API backend service parameter type, which is used only if ServiceType is HTTP.
Note: this field may return null, indicating that no valid values can be obtained.

ServiceReleaseHistory

Service release history

Used by actions: DescribeServiceEnvironmentReleaseHistory.

Name Type Description
TotalCount Integer Total number of published versions.
Note: this field may return null, indicating that no valid values can be obtained.
VersionList Array of ServiceReleaseHistoryInfo Historical version list.
Note: this field may return null, indicating that no valid values can be obtained.

ServiceReleaseHistoryInfo

Service release list details

Used by actions: DescribeServiceEnvironmentReleaseHistory.

Name Type Description
VersionName String Version ID.
Note: this field may return null, indicating that no valid values can be obtained.
VersionDesc String Version description.
Note: this field may return null, indicating that no valid values can be obtained.
ReleaseTime String Version release time.
Note: this field may return null, indicating that no valid values can be obtained.

ServiceReleaseVersion

Service release version

Used by actions: DescribeServiceReleaseVersion.

Name Type Description
TotalCount Integer Total number of published versions.
Note: this field may return null, indicating that no valid values can be obtained.
VersionList Array of DescribeServiceReleaseVersionResultVersionListInfo Release version list.
Note: this field may return null, indicating that no valid values can be obtained.

ServiceSubDomainMappings

Custom service domain name path mapping

Used by actions: DescribeServiceSubDomainMappings.

Name Type Description
IsDefaultMapping Boolean Whether the default path mapping is used. true: use the default path mapping; false: use the custom path mapping (PathMappingSet is required in this case).
PathMappingSet Array of PathMapping Custom path mapping list.

ServiceUsagePlanSet

List of usage plans bound to service

Used by actions: DescribeServiceUsagePlan.

Name Type Description
TotalCount Integer Total number of usage plans bound to service.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceUsagePlanList Array of ApiUsagePlan List of usage plans bound to service.
Note: this field may return null, indicating that no valid values can be obtained.

ServicesStatus

Service list display

Used by actions: DescribeServicesStatus.

Name Type Description
TotalCount Integer Total number of services in list.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceSet Array of Service Service list details.
Note: this field may return null, indicating that no valid values can be obtained.

Tag

Information of tag bound to API.

Used by actions: CreateApiKey, CreatePlugin, CreateService, CreateUpstream, DescribeApi, DescribeApiForApiApp, DescribeService, DescribeServiceForApiApp, DescribeServicesStatus, DescribeUpstreams, ModifyApi.

Name Type Required Description
Key String Yes Tag key
Value String Yes Tag value

TargetServicesReq

TSF Serverless input parameters

Used by actions: CreateApi.

Name Type Required Description
VmIp String Yes VM IP
VpcId String Yes VPC ID
VmPort Integer Yes VM Port
HostIp String Yes IP of the host where the CVM instance resides
DockerIp String No Docker IP

TsfLoadBalanceConfResp

TsfLoadBalanceConf output parameter usage

Used by actions: CreateApi, DescribeApi, DescribeApiForApiApp, ModifyApi.

Name Type Required Description
IsLoadBalance Boolean No Whether load balancing is enabled.
Note: this field may return null, indicating that no valid values can be obtained.
Method String No Load balancing method.
Note: this field may return null, indicating that no valid values can be obtained.
SessionStickRequired Boolean No Whether session persistence is enabled.
Note: this field may return null, indicating that no valid values can be obtained.
SessionStickTimeout Integer No Session persistence timeout period.
Note: this field may return null, indicating that no valid values can be obtained.

UpstreamHealthChecker

Upstream health check parameter configuration

Used by actions: CreateUpstream, DescribeUpstreams, ModifyUpstream.

Name Type Required Description
EnableActiveCheck Boolean Yes Specifies whether to enable active health check
EnablePassiveCheck Boolean Yes Specifies whether the enable passive health check
HealthyHttpStatus String Yes The HTTP status code that indicates that the upstream is healthy
UnhealthyHttpStatus String Yes The HTTP status code that indicates that the upstream is unhealthy
TcpFailureThreshold Integer Yes The threshold on consecutive TCP errors. Range: [0, 254]. 0 indicates not to check TCP.
TimeoutThreshold Integer Yes The threshold on consecutive timeouts. Range: [0, 254]. 0 indicates not to check TCP.
HttpFailureThreshold Integer Yes The threshold on consecutive HTTP errors. Range: [0, 254]. 0 indicates not to check HTTP.
ActiveCheckHttpPath String No The path for active health check. It defaults to /.
ActiveCheckTimeout Integer No The timeout period for active health check in seconds. Default: 5.
ActiveCheckInterval Integer No The interval for active health check in seconds. Default: 5.
ActiveRequestHeader Array of UpstreamHealthCheckerReqHeaders No Header of the active health check request
UnhealthyTimeout Integer No The period for an abnormal to recover automatically in seconds. If only the passive health check is enabled, it must be greater than 0. Otherwise the abnormal nodes can not recovered automatically. The default value is 30 seconds.

UpstreamHealthCheckerReqHeaders

The request header configuration of active upstream health check requests

Used by actions: CreateUpstream, ModifyUpstream.

Name Type Required Description

UpstreamInfo

Upstream details

Used by actions: DescribeUpstreams.

Name Type Description
UpstreamId String Unique upstream ID
UpstreamName String Upstream name
UpstreamDescription String Upstream description
Scheme String Backend protocol. Valid values: HTTP, HTTPS
Algorithm String Load balancing algorithm. Valid value: ROUND_ROBIN
UniqVpcId String Unique VPC ID
Retries Integer Number of retry attempts
Nodes Array of UpstreamNode Backend nodes
CreatedTime Timestamp ISO8601 Creation time.
Tags Array of Tag Label
Note: This field may return null, indicating that no valid value was found.
HealthChecker UpstreamHealthChecker Health check configuration
Note: This field may return null, indicating that no valid value was found.
UpstreamType String Upstream type. Valid values: IP_PORT, K8S
K8sServices Array of K8sService Configuration of TKE service
Note: This field may return NULL, indicating that no valid value was found.
UpstreamHost String The Host header that the gateway forwards to the upstream
Note: This field may return NULL, indicating that no valid value was found.

UpstreamNode

Upstream node metadata

Used by actions: CreateUpstream, DescribeUpstreams, ModifyUpstream.

Name Type Required Description
Host String Yes IP or domain name
Port Integer Yes The port number. Range: [0, 65535]
Weight Integer Yes Value range: [0, 100]. 0 refers to disable it.
VmInstanceId String No CVM Instance ID
Note: This field may return NULL, indicating that no valid value was found.
Tags Array of String No Tag
Note: This field may return null, indicating that no valid value was found.
Healthy String No Health status of the node. Values: OFF, HEALTHY, UNHEALTHY and NO_DATA. It’s not required for creating and editing actions. It only supports VPC upstreams.
Note: This field may return NULL, indicating that no valid value was found.
ServiceName String No TKE container name
Note: This field may return NULL, indicating that no valid value was found.
NameSpace String No TKE namespace
Note: This field may return NULL, indicating that no valid value was found.
ClusterId String No ID of the TKE cluster
Note: This field may return null, indicating that no valid value was found.
Source String No Node source. Valid value: K8S
Note: This field may return NULL, indicating that no valid value was found.
UniqueServiceName String No The unique service name in API Gateway
Note: This field may return null, indicating that no valid value was found.

UsagePlan

usagePlan details

Used by actions: DescribeService, DescribeServiceForApiApp.

Name Type Description
Environment String Environment name.
UsagePlanId String Unique usage plan ID.
UsagePlanName String Usage plan name.
UsagePlanDesc String Usage plan description.
Note: This field may return null, indicating that no valid values can be obtained.
MaxRequestNumPreSec Integer Usage plan QPS. -1 indicates no limit.
CreatedTime Timestamp ISO8601 Usage plan time.
ModifiedTime Timestamp ISO8601 Usage plan modification time.

UsagePlanBindEnvironment

Information of environment bound to usage plan

Used by actions: CreateUsagePlan, DescribeUsagePlan, ModifyUsagePlan.

Name Type Description
EnvironmentName String Environment name.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceId String Unique service ID.
Note: this field may return null, indicating that no valid values can be obtained.

UsagePlanBindSecret

Key bound to usage plan

Used by actions: DescribeUsagePlanSecretIds.

Name Type Description
AccessKeyId String Key ID.
Note: this field may return null, indicating that no valid values can be obtained.
SecretName String Key name.
Note: this field may return null, indicating that no valid values can be obtained.
Status Integer Key status. 0: disabled. 1: enabled.
Note: this field may return null, indicating that no valid values can be obtained.

UsagePlanBindSecretStatus

List of keys bound to usage plan.

Used by actions: DescribeUsagePlanSecretIds.

Name Type Description
TotalCount Integer Number of keys bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
AccessKeyList Array of UsagePlanBindSecret List of key details.
Note: this field may return null, indicating that no valid values can be obtained.

UsagePlanEnvironment

Details of environments bound to usage plan.

Used by actions: DescribeUsagePlanEnvironments.

Name Type Description
ServiceId String Unique ID of bound service.
Note: this field may return null, indicating that no valid values can be obtained.
ApiId String Unique API ID.
Note: this field may return null, indicating that no valid values can be obtained.
ApiName String API name.
Note: this field may return null, indicating that no valid values can be obtained.
Path String API path.
Note: this field may return null, indicating that no valid values can be obtained.
Method String API method.
Note: this field may return null, indicating that no valid values can be obtained.
Environment String Name of bound environment.
Note: this field may return null, indicating that no valid values can be obtained.
InUseRequestNum Integer Used quota.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNum Integer Maximum number of requests.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNumPreSec Integer Maximum number of requests per second.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ServiceName String Service name.
Note: this field may return null, indicating that no valid values can be obtained.

UsagePlanEnvironmentStatus

List of environments bound to usage plan.

Used by actions: DescribeUsagePlanEnvironments.

Name Type Description
TotalCount Integer Number of environments of the service bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.
EnvironmentList Array of UsagePlanEnvironment Environment status of services bound to usage plan.
Note: this field may return null, indicating that no valid values can be obtained.

UsagePlanInfo

Usage plan details.

Used by actions: CreateUsagePlan, DescribeUsagePlan, ModifyUsagePlan.

Name Type Description
UsagePlanId String Unique usage plan ID.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanName String Usage plan name.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanDesc String Usage plan description.
Note: this field may return null, indicating that no valid values can be obtained.
InitQuota Integer Number of initialization calls.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNumPreSec Integer Limit of requests per second.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNum Integer Maximum number of calls.
Note: this field may return null, indicating that no valid values can be obtained.
IsHide Integer Whether to hide.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
BindSecretIdTotalCount Integer Number of bound keys.
Note: this field may return null, indicating that no valid values can be obtained.
BindSecretIds Array of String Details of bound keys.
Note: this field may return null, indicating that no valid values can be obtained.
BindEnvironmentTotalCount Integer Number of bound environments.
Note: this field may return null, indicating that no valid values can be obtained.
BindEnvironments Array of UsagePlanBindEnvironment Details of bound environments.
Note: this field may return null, indicating that no valid values can be obtained.

UsagePlanStatusInfo

Usage plan list display.

Used by actions: DescribeUsagePlansStatus.

Name Type Description
UsagePlanId String Unique usage plan ID.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanName String Custom usage plan name.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanDesc String Custom usage plan description.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNumPreSec Integer Maximum number of requests per second.
Note: this field may return null, indicating that no valid values can be obtained.
MaxRequestNum Integer Total number of requests allowed. -1 indicates no limit.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.
ModifiedTime Timestamp ISO8601 Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.

UsagePlansStatus

Usage plan list

Used by actions: DescribeUsagePlansStatus.

Name Type Description
TotalCount Integer Number of eligible usage plans.
Note: this field may return null, indicating that no valid values can be obtained.
UsagePlanStatusSet Array of UsagePlanStatusInfo Usage plan list.
Note: this field may return null, indicating that no valid values can be obtained.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support