CreateApi

Last updated: 2020-08-20 18:05:40

1. API Description

Domain name for API request: apigateway.tencentcloudapi.com.

This API is used to create an API. Before creating an API, you need to create a service, as each API belongs to a certain service.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateApi.
Version Yes String Common parameter. The value used for this API: 2018-08-08.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ServiceId Yes String Unique service ID of API.
ServiceType Yes String API backend service type. Valid values: HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, TARGET (in beta test).
ServiceTimeout Yes Integer API backend service timeout period in seconds.
Protocol Yes String API frontend request type, such as HTTP, HTTPS, or HTTP and HTTPS.
RequestConfig Yes ApiRequestConfig Request frontend configuration.
ApiName No String Custom API name.
ApiDesc No String Custom API description.
ApiType No String API type. Valid values: NORMAL (general API), TSF (microservice API). Default value: NORMAL.
AuthType No String API authentication type. Valid values: SECRET (key pair authentication), NONE (no authentication), OAUTH. Default value: NONE.
EnableCORS No Boolean Whether to enable CORS.
ConstantParameters.N No Array of ConstantParameter Constant parameter.
RequestParameters.N No Array of RequestParameter Frontend request parameter.
ApiBusinessType No String This field is valid if AuthType is OAUTH. NORMAL: business API; OAUTH: authorization API.
ServiceMockReturnMessage No String Returned message of API backend Mock, which is required if ServiceType is Mock.
MicroServices.N No Array of MicroServiceReq List of microservices bound to API.
ServiceTsfLoadBalanceConf No TsfLoadBalanceConfResp Load balancing configuration of microservice.
ServiceTsfHealthCheckConf No HealthCheckConf Health check configuration of microservice.
TargetServices.N No Array of TargetServicesReq target type backend resource information (in beta test).
TargetServicesLoadBalanceConf No Integer target type load balancing configuration (in beta test).
TargetServicesHealthCheckConf No HealthCheckConf target health check configuration (in beta test).
ServiceScfFunctionName No String SCF function name, which takes effect if the backend type is SCF.
ServiceWebsocketRegisterFunctionName No String SCF WebSocket registration function, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceWebsocketCleanupFunctionName No String SCF WebSocket cleanup function, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceWebsocketTransportFunctionName No String SCF WebSocket transfer function, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceScfFunctionNamespace No String SCF function namespace, which takes effect if the backend type is SCF.
ServiceScfFunctionQualifier No String SCF function version, which takes effect if the backend type is SCF.
ServiceWebsocketRegisterFunctionNamespace No String SCF WebSocket registration function namespace, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceWebsocketRegisterFunctionQualifier No String SCF WebSocket transfer function version, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceWebsocketTransportFunctionNamespace No String SCF WebSocket transfer function namespace, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceWebsocketTransportFunctionQualifier No String SCF WebSocket transfer function version, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceWebsocketCleanupFunctionNamespace No String SCF WebSocket cleanup function namespace, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceWebsocketCleanupFunctionQualifier No String SCF WebSocket cleanup function version, which takes effect if the frontend type is WEBSOCKET and the backend type is SCF.
ServiceScfIsIntegratedResponse No Boolean Whether to enable response integration, which takes effect if the backend type is SCF.
IsDebugAfterCharge No Boolean Billing after debugging starts (reserved field for marketplace).
IsDeleteResponseErrorCodes No Boolean Whether to delete the error codes for custom response configuration. If the value is left empty or False, the error codes will not be deleted. If the value is True, all custom response configuration error codes of the API will be deleted.
ResponseType No String Return type.
ResponseSuccessExample No String Sample response for successful custom response configuration.
ResponseFailExample No String Sample response for failed custom response configuration.
ServiceConfig No ServiceConfig API backend service configuration.
AuthRelationApiId No 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.
ServiceParameters.N No Array of ServiceParameter API backend service parameter.
OauthConfig No OauthConfig OAuth configuration, which takes effect if AuthType is OAUTH.
ResponseErrorCodes.N No Array of ResponseErrorCodeReq Custom error code configuration.
TargetNamespaceId No String TSF Serverless namespace ID (in beta test).
UserType No String User type.

3. Output Parameters

Parameter Name Type Description
Result CreateApiRsp API information
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 CreateApi

Input Example

https://apigateway.tencentcloudapi.com/?Action=CreateApi
&ServiceId=service-ody35h5e
&ApiName=name
&ApiDesc=desc
&ApiType=NORMAL
&AuthType=NONE
&ServiceType=MOCK
&ServiceTimeout=15
&Protocol=HTTP
&RequestConfig.Path=/test
&RequestConfig.Method=GET
&EnableCORS=false
&ApiBusinessType=NORMAL
&ServiceMockReturnMessage=mock
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "ApiId": "api-61jyuvg6",
      "Path": "test",
      "Method": "GET",
      "CreatedTime": "2020-03-23T08:59:18Z"
    },
    "RequestId": "96026454-d916-4035-ba88-0e900214d0f6"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.ServiceError Service-related error.
InternalError.OssException OSS internal error.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidApiRequestConfig Invalid API configuration.
InvalidParameterValue.InvalidRequestParameters Invalid request parameter.
InvalidParameterValue.InvalidServiceConfig Invalid service configuration.
LimitExceeded.ApiCountLimitExceeded Exceeded API quota.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help