All Products
Search
Document Center

API Gateway:CreateBackendModel

Last Updated:Dec 24, 2025

Creates a backend service configuration in an environment.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:CreateBackendModel

create

*Backend

acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}

None None

Request parameters

Parameter

Type

Required

Description

Example

BackendId

string

No

The ID of the backend service.

34e94fcd3e2e47a49824a89b8f92cb5e

BackendType

string

No

The type of the backend service.

HTTP

StageName

string

No

The environment of the API.

  • RELEASE: The production environment.

  • PRE: The staging environment.

  • TEST: The test environment.

TEST

BackendModelData

string

No

The data of the backend model.

{\"ServiceAddress\":\"http://apigateway-echo-redux.alicloudapi.com:8080\"}

Description

string

No

The description of the backend model.

model description

Response elements

Element

Type

Description

Example

object

BackendModelId

string

The ID of the backend model.

4be6b110b7aa40b0bf0c83cc00b3bd86

RequestId

string

The ID of the request.

64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA

Examples

Success response

JSON format

{
  "BackendModelId": "4be6b110b7aa40b0bf0c83cc00b3bd86",
  "RequestId": "64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.