International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2021-02-03 17:23:40

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.

ApiEnvironmentStrategyStataus

List of policies bound to API

Used by actions: DescribeApiEnvironmentStrategy.

Name Type Description
TotalCount Integer Number of throttling policies bound to API.
Note: this field may return null, indicating that no valid values can be obtained.
ApiEnvironmentStrategySet Array of ApiEnvironmentStrategy List of throttling policies bound to API.
Note: this field may return null, indicating that no valid values can be obtained.

ApiIdStatus

API status

Used by actions: DescribeService.

Name Type Description
ServiceId String Unique service ID.
ApiId String Unique API ID.
ApiDesc String API description
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.
RelationBuniessApiIds Array of String List of business APIs associated with 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.

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 ServiceParameter 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.

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.

ApisStatus

API list status description

Used by actions: DescribeApisStatus.

Name Type Description
TotalCount Integer Number of eligible APIs.
ApiIdStatusSet Array of DesApisStatus API list.

Base64EncodedTriggerRule

Header trigger rule for Base64 encoding.

Used by actions: DescribeApi, 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 (., +, *,