All Products
Search
Document Center

API Gateway:CreateBackend

Last Updated:Feb 09, 2023

Creates a backend service in API Gateway.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
apigateway:CreateBackendWrite
  • ApiGateway
    acs:apigateway:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackendNamestringYes

The name of the backend service.

testBackendService
BackendTypestringYes

The type of the backend service. Valid values: HTTP, VPC, FC_EVENT, FC_HTTP, OSS, and MOCK.

HTTP
DescriptionstringNo

The description of the backend service.

HTTP backend
CreateEventBridgeServiceLinkedRolebooleanNo

Specifies whether to create a role associated with EventBridge.

true

Response parameters

ParameterTypeDescriptionExample
object
BackendIdstring

The ID of the backend service.

0d105f80a8f340408bd34954d4e4ff22
RequestIdstring

The ID of the request.

66D84355-164D-53ED-81FF-03DCF181DE24

Example

Normal return example

JSONFormat

{
  "BackendId": "0d105f80a8f340408bd34954d4e4ff22",
  "RequestId": "66D84355-164D-53ED-81FF-03DCF181DE24"
}

Error codes

For a list of error codes, visit the API error center.