Update API Gateway Backend Definitions with ModifyBackendModel - API Gateway

This operation modifies the definition of a backend service in an environment. After the modification, the backend addresses of APIs that use this backend service and are published in this environment are batch updated automatically, without requiring manual publishing.

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:ModifyBackendModel

update

*Backend

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

None

Request parameters

Parameter	Type	Required	Description	Example
BackendId	string	No	Backend ID	20bcdc9453524b78a8beb1f6de21edb7
BackendType	string	No	Backend type	OSS
StageName	string	No	Specify the environment for the API operation. RELEASE: Online PRE: Pre-release TEST: Test	TEST
BackendModelId	string	No	Backend Model ID	3bb6375bc71c4e4c95ce05b4e7a55a9d
BackendModelData	string	No	Backend Model Data.	{\"ServiceAddress\":\"http://121.40.XX.XX\"}
Description	string	No	Description of the backend model definition	modify plugin first

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	19B89B04-418B-55EE-94A8-6B42CA06002A
OperationId	string	Operation ID.	c16a1880f5164d779f6a54f64d997cd9

Examples

Success response

JSON format

{
  "RequestId": "19B89B04-418B-55EE-94A8-6B42CA06002A",
  "OperationId": "c16a1880f5164d779f6a54f64d997cd9"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.