CreateApi - API Gateway - Alibaba Cloud Documentation Center

Creates an API.

Operation description

This operation is intended for API providers.
The name of an API must be unique within an API group.
A request path must be unique within an API group.
The QPS limit on this operation is 50 per user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group.	08ae4aa0f95e4321849ee57f4e0b3077
ApiName	string	Yes	The name of the API that you want to create. The name must be unique within the API group. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (_).	ApiName
Visibility	string	Yes	Specifies whether to make the API public. Valid values: PUBLIC: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment. PRIVATE: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.	PUBLIC
Description	string	No	The description of the API. The description can be up to 180 characters in length.	Api description
AuthType	string	No	The configuration items of API requests sent by the consumer to API Gateway. For more information, see RequestConfig .	APP
RequestConfig	string	Yes	The configuration items of API requests sent by API Gateway to the backend service. For more information, see ServiceConfig .	{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}
ServiceConfig	string	Yes	The parameters of API requests sent by the consumer to API Gateway. For more information, see RequestParameter .	{"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}
RequestParameters	string	No	The common parameters of APIs in JSON format.	\[{\\"demoValue\\":\\"12345678\\",\\"description\\":\\"ConsumerAppKey\\",\\"location\\":\\"HEAD\\",\\"parameterName\\":\\"CaAppKey\\",\\"serviceParameterName\\":\\"X-Ca-Key\\"}]
SystemParameters	string	No	The parameters of the API.	[{\"demoValue\":\"12345678\",\"description\":\"ConsumerAppKey\",\"location\":\"HEAD\",\"parameterName\":\"CaAppKey\",\"serviceParameterName\":\"X-Ca-Key\"}]
ConstantParameters	string	No	The parameters of API requests sent by API Gateway to the backend service. For more information, see ServiceParameter .	\[{"ServiceParameterName":"age","Location":"Head","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"sex","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"userId","Location":"Path","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"clientIp","Location":"Head","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"constance","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]
ServiceParameters	string	No	The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service. For more information, see ServiceParameterMap .	[{"ServiceParameterName":"age","Location":"Head","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"sex","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"userId","Location":"Path","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"clientIp","Location":"Head","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"constance","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]
ServiceParametersMap	string	No	The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.	[{"ServiceParameterName":"age","RequestParameterName":"age"},{"ServiceParameterName":"sex","RequestParameterName":"sex"},{"ServiceParameterName":"userId","RequestParameterName":"userId"},{"ServiceParameterName":"clientIp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"constance","RequestParameterName":"constance"}]
ResultType	string	No	The sample response from the backend service.	HTML
ResultSample	string	No	An example of a response returned by the backend service. This value is used only to generate documentation. The actually returned result shall prevail.	200
FailResultSample	string	No	The sample error codes returned by the backend service. For more information, see ErrorCodeSample .	{"errorCode":"fail","errorMessage":"param invalid"}
ErrorCodeSamples	string	No	The return description of the API.	\[]
ResultDescriptions	string	No	The switch status of ACL. Valid values:- on and off.	[]
OpenIdConnectConfig	string	No	If the AuthType is APP authentication, you need to pass this value to specify the signature algorithm. If you do not specify this parameter, the default value HmacSHA256 is used. Valid values: HmacSHA256 HmacSHA1,HmacSHA256	{\"openIdApiType\":null,\"idTokenParamName\":null,\"publicKeyId\":null,\"publicKey\":null}
AllowSignatureMethod	string	No	The type of the two-way communication API. COMMON: normal APIs REGISTER: registered APIs UNREGISTER: unregistered APIs NOTIFY: downstream notification APIs	HmacSHA256
WebSocketApiType	string	No	The return description of the API.	COMMON
ResultBodyModel	string	No	Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks. If you set ForceNonceCheck to false, the check is not performed. The default value is false when you create an API.	{}
ForceNonceCheck	boolean	No	Specifies whether to set DisableInternet to true to limit API calls to within the VPC. If you set DisableInternet to false, the limit is lifted. The default value is false when you create an API.	true
DisableInternet	boolean	No	If AuthType is set to APP, the valid values are: DEFAULT: The default value that is used if no other values are passed. This value means that the setting of the group is used. DISABLE: The authentication is disabled. HEADER: AppCode can be placed in the Header parameter for authentication. HEADER_QUERY: AppCode can be placed in the Header or Query parameter for authentication.	true
AppCodeAuthType	string	No	The IDof the backend service	HEADER
BackendId	string	No	Specifies whether to enable backend services.	a0305308908c4740aba9cbfd63ba99b7
BackendEnable	boolean	No	Specifies whether to enable backend services.	true
Tag	array<object>	No	The list of tags.
	object	No
Key	string	No	The key of the tag.	env
Value	string	No	The value of the tag.	value

Response parameters

Parameter	Type	Description	Example
	object
ApiId	string	The ID of the API.	8afff6c8c4c6447abb035812e4d66b65
RequestId	string	The ID of the request.	6C87A26A-6A18-4B8E-8099-705278381A2C

Examples

Sample success responses

JSONformat

{
  "ApiId": "8afff6c8c4c6447abb035812e4d66b65",
  "RequestId": "6C87A26A-6A18-4B8E-8099-705278381A2C"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-07	The request parameters of the API has changed	View Change Details
2023-05-30	The internal configuration of the API is changed, but the call is not affected	View Change Details