All Products
Search
Document Center

API Gateway:CreateBackend

Last Updated:Sep 25, 2024

Creates a backend service in API Gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • 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 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
apigateway:CreateBackendcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackendNamestringYes

The name of the backend service.

testBackendService
BackendTypestringYes

The type of the backend service.

HTTP
DescriptionstringNo

The description.

release data api 411055691504981
CreateEventBridgeServiceLinkedRolebooleanNo

Specifies to create a EventBridge service-linked role.

true
CreateSlrbooleanNo

Specifies to create a service-linked role.

true
Tagarray<object>No

The tag of objects that match the rule. You can specify multiple tags.

objectNo
KeystringNo

The key of the tag.

key
ValuestringNo

The value of the tag.

123

Response parameters

ParameterTypeDescriptionExample
object
BackendIdstring

The ID of the backend service.

0d105f80a8f340408bd34954d4e4ff22
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-15The request parameters of the API has changedView Change Details
2023-11-09The request parameters of the API has changedView Change Details