Documentation | Tencent Cloud

Recent Pages

Data Types

Last updated: 2021-01-22 11:09:37

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
IsBase64Trigger	Boolean
Base64EncodedTriggerRules	Array of Base64EncodedTriggerRule

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

Used by actions: DescribeApi.

Name	Type	Required	Description
Name	String	Yes
Value	Array of String	Yes

ConstantParameter

Constant parameter

Used by actions: CreateApi, DescribeApi, ModifyApi.

Name	Type	Required	Description
Name	String	No	Constant parameter name, which is used only if `ServiceType` is `HTTP`.
Desc	String	No	Constant parameter description, which is used only if `ServiceType` is `HTTP`.
Position	String	No	Constant parameter position, which is used only if `ServiceType` is `HTTP`.
DefaultValue	String	No	Default value of constant parameter, which is used only if `ServiceType` is `HTTP`.

CreateApiRsp

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

DesApisStatus

API status details

Used by actions: CreateIPStrategy, DescribeApisStatus, DescribeIPStrategy, DescribeIPStrategysStatus.

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

DocumentSDK

API document download

Used by actions: GenerateApiDocument.

Name	Type	Description
DocumentURL	String	Download link of generated file. Generated documents will be stored in COS.
SdkURL	String	Download link of generated SDK file. Generated SDK files will be stored in COS.

DomainSetList

Custom service domain name list

Used by actions: DescribeServiceSubDomains.

Name	Type	Description
DomainName	String	Domain name.
Status	Integer	Domain name resolution status. True: success; False: failure.
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.

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.

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: DescribeApiKeysStatus, DescribeApisStatus, DescribeIPStrategy, DescribeIPStrategyApisStatus, DescribeIPStrategysStatus, DescribeLogSearch, DescribeServicesStatus, 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, ModifyApi.

Name	Type	Required	Description
IsHealthCheck	Boolean	No	Whether health check is enabled.
RequestVolumeThreshold	Integer	No	Health check threshold.
SleepWindowInMilliseconds	Integer	No	Window size.
ErrorThresholdPercentage	Integer	No	Threshold percentage.

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.

IPStrategysStatus

Policy list

Used by actions: DescribeIPStrategysStatus.

Name	Type	Description
TotalCount	Integer	Number of policies. Note: this field may return null, indicating that no valid values can be obtained.
StrategySet	Array of IPStrategy	Policy list. Note: this field may return null, indicating that no valid values can be obtained.

LogQuery

Search criterion input parameter

Used by actions: DescribeLogSearch.

Name	Type	Required	Description
Name	String	Yes	Search field
Operator	String	Yes	Operator
Value	String	Yes	Search value

MicroService

Information of microservice bound to API.

Used by actions: DescribeApi.

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.

OauthConfig

OAuth authorization configuration information

Used by actions: CreateApi, CreateIPStrategy, DescribeApi, DescribeApisStatus, DescribeIPStrategy, DescribeIPStrategysStatus, DescribeService, 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.

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, 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, 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	Yes	Custom response configuration error code.
Msg	String	Yes	Custom response configuration error message.
Desc	String	Yes	Custom response configuration error code remarks.
ConvertedCode	Integer	Yes	Custom error code conversion.
NeedConvert	Boolean	Yes	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.

ServiceConfig

Used by actions: CreateApi, DescribeApi, ModifyApi.

Name	Type	Required	Description
Product	String	No	Backend type, which takes effect when VPC is enabled. Currently, only `clb` is supported.
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

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.

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

Used by actions: CreateApi, DescribeApi, 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, 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.
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 ServiceReleaseHistoryInfo	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: CreateService, DescribeApi, DescribeService, DescribeServicesStatus, ModifyApi.

Name	Type	Description
Key	String	Tag key.
Value	String	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, ModifyApi.

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

UsagePlan

usagePlan details

Used by actions: DescribeService.

Name	Type	Description
Environment	String	Environment name.
UsagePlanId	String	Unique usage plan ID.
UsagePlanName	String	Usage plan name.
UsagePlanDesc	String	Usage plan description.
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?

Confirm

Was this page helpful?

Not at all
Not very helpful
Somewhat helpful
Very helpful
Extremely helpful

Send Feedback

Hide

Submit a Ticket Contact sales

Help

Sign Up

Log in

Recent Pages

Data Types

ApiEnvironmentStrategy

ApiEnvironmentStrategyStataus

ApiIdStatus

ApiInfo

ApiKey

ApiKeysStatus

ApiRequestConfig

ApiUsagePlan

ApiUsagePlanSet

ApisStatus

Base64EncodedTriggerRule

ConstantParameter

CreateApiRsp

DesApisStatus

DocumentSDK

DomainSetList

DomainSets

Environment

EnvironmentStrategy

ErrorCodes

Filter

HealthCheckConf

IPStrategy

IPStrategyApi

IPStrategyApiStatus

IPStrategysStatus

LogQuery

MicroService

MicroServiceReq

OauthConfig

PathMapping

ReleaseService

ReqParameter

RequestConfig

RequestParameter

ResponseErrorCodeReq

Service

ServiceConfig

ServiceEnvironmentSet

ServiceEnvironmentStrategy

ServiceEnvironmentStrategyStatus

ServiceParameter

ServiceReleaseHistory

ServiceReleaseHistoryInfo

ServiceReleaseVersion

ServiceSubDomainMappings

ServiceUsagePlanSet

ServicesStatus

Tag

TargetServicesReq

TsfLoadBalanceConfResp

UsagePlan

UsagePlanBindEnvironment

UsagePlanBindSecret

UsagePlanBindSecretStatus

UsagePlanEnvironment

UsagePlanEnvironmentStatus

UsagePlanInfo

UsagePlanStatusInfo

UsagePlansStatus

Was this page helpful?

Was this page helpful?

About Tencent Cloud

Help & Support

User Center

Resources

7x24 Hotline