CreateHttpApi - API Gateway - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Creates an HTTP API.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apig:CreateHttpApi	create	HttpApi `acs:apig:{#regionId}:{#accountId}:httpapi/`	none	none

Request syntax

POST /v1/http-apis HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	$.parameters[0].schema.properties.ingressConfig.enumValueTitles
name	string	Yes	$.parameters[0].schema.example	test-api
description	string	No	$.parameters[0].schema.properties.aiProtocols.items.description	$.parameters[0].schema.properties.aiProtocols.items.example
protocols	array	No	$.parameters[0].schema.properties.aiProtocols.description
	string	No	$.parameters[0].schema.properties.aiProtocols.enumValueTitles	HTTP
basePath	string	No	$.parameters[0].schema.properties.deployConfigs.items.example	/v1
versionConfig	HttpApiVersionConfig	No	$.parameters[0].schema.properties.deployConfigs.items.enumValueTitles
type	string	No	$.parameters[0].schema.properties.deployConfigs.description	Http
ingressConfig	object	No	$.parameters[0].schema.properties.deployConfigs.example
environmentId	string	No	$.parameters[0].schema.properties.deployConfigs.enumValueTitles	env-cq146allhtgk***
sourceId`deprecated`	string	No	$.parameters[0].schema.properties.enableAuth.description	src-crdddallhtgtr***
ingressClass	string	No	$.parameters[0].schema.properties.enableAuth.example	mse
watchNamespace	string	No	$.parameters[0].schema.properties.enableAuth.enumValueTitles	default
overrideIngressIp	boolean	No	$.parameters[0].schema.properties.authConfig.description	false
clusterId	string	No	Cluster ID.	k7v5eobfzttudni2pw***
resourceGroupId	string	No	$.parameters[0].schema.properties.authConfig.example	rg-xxx
aiProtocols	array	No	$.parameters[0].schema.properties.authConfig.enumValueTitles
	string	No	$.parameters[0].schema.description	OpenAI/v1
agentProtocols	array	No	Agent protocols
	string	No	string	http/https
deployConfigs	array	No	$.parameters[0].schema.example
	HttpApiDeployConfig	No	$.parameters[0].schema.enumValueTitles
enableAuth	boolean	No	Create an API of HTTP type	true
authConfig	AuthConfig	No	The request parameters for API creation.
modelCategory	string	No	Model category	llm/text-to-image
removeBasePathOnForward	boolean	No	Whether to remove base path when forwarding	true
firstByteTimeout	integer	No	First byte timeout	30

Response parameters

Parameter	Type	Description	Example
	object	The API name.
requestId	string	The API description.	A1994B10-C6A8-58FA-8347-6A08B0D4EFDE
code	string	API for testing	Ok
message	string	The protocol list for API access.	success
data	object	A protocol.
httpApiId	string	HTTP API ID。	api-xxx
name	string	The API base path, which must start with a forward slash (/).	test-api

Examples

Sample success responses

JSONformat

{
  "requestId": "A1994B10-C6A8-58FA-8347-6A08B0D4EFDE",
  "code": "Ok",
  "message": "success",
  "data": {
    "httpApiId": "api-xxx",
    "name": "test-api"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-07-17	The internal configuration of the API is changed, but the call is not affected	View Change Details
2025-06-26	The internal configuration of the API is changed, but the call is not affected	View Change Details
2025-04-25	The internal configuration of the API is changed, but the call is not affected	View Change Details
2025-01-02	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-11-20	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-11-18	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-09-06	The internal configuration of the API is changed, but the call is not affected	View Change Details