All Products
Search
Document Center

API Gateway:CreateHttpApi

Last Updated:Mar 19, 2025
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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apig:CreateHttpApicreate
*HttpApi
acs:apig:{#regionId}:{#accountId}:httpapi/*
    none
none

Request syntax

POST /v1/http-apis HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The information about the API to be created.

namestringYes

The API name.

test-api
descriptionstringNo

The API description.

API for testing
protocolsarrayNo

The protocols that are used to call the API.

stringNo

The protocol.

HTTP
basePathstringNo

The API base path, which must start with a forward slash (/).

/v1
versionConfigHttpApiVersionConfigNo

The versioning configuration of the API.

typestringNo

The API type. Valid values:

  • Http
  • Rest
  • WebSocket
  • HttpIngress
Http
ingressConfigobjectNo

The HTTP Ingress configurations.

environmentIdstringNo

The environment ID.

env-cq146allhtgk***
sourceIdstringNo

The source ID.

src-crdddallhtgtr***
ingressClassstringNo

The Ingress Class for listening.

mse
watchNamespacestringNo

The namespace for listening.

default
overrideIngressIpbooleanNo

Specifies whether to update the address in Ingress Status.

false
resourceGroupIdstringNo

The resource group ID.

rg-aekzgvmlotionbi
aiProtocolsarrayNo

The AI API protocols. Valid value:

  • OpenAI/v1
stringNo

The AI API protocol.

OpenAI/v1
deployConfigsarrayNo

The API deployment configurations. Currently, only AI APIs support deployment configurations, and only a single deployment configuration can be passed.

HttpApiDeployConfigNo

The API deployment configuration.

enableAuthbooleanNo

Specifies whether to enable authentication.

authConfigAuthConfigNo

The authentication configurations.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

The request ID.

A1994B10-C6A8-58FA-8347-6A08B0D4EFDE
codestring

The status code.

Ok
messagestring

The returned message.

success
dataobject

The API information.

httpApiIdstring

The HTTP API ID.

api-xxx
namestring

The API name.

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 timeSummary of changesOperation
2025-01-02The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-11-20The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-11-18The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-09-06The internal configuration of the API is changed, but the call is not affectedView Change Details