DescribeBackendList API Overview for Backend Services - API Gateway

Queries backend services. You can filter backend services by backend service name and backend service type.

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

get

*Backend

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

None

Request parameters

Parameter	Type	Required	Description	Example
BackendName	string	No	The name of the backend service. You can use * to perform fuzzy queries.	test
BackendType	string	No	The type of the backend service.	HTTP
PageNumber	integer	No	The number of the current page.	1
PageSize	integer	No	The number of entries to return on each page.	10
Tag	array<object>	No	The list of the tag.
	object	No
Key	string	No	The key of the tag.	test1
Value	string	No	The value of the tag.	value

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The number of the current page.	1
RequestId	string	The ID of the request.	090A0DF9-9144-5236-8CBA-E18DE317722D
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries returned.	1
BackendInfoList	array<object>	The backend services.
	array<object>
BackendName	string	The name of the backend service.	test
BackendType	string	The type of the backend service.	HTTP
ModifiedTime	string	The time when the backend service was modified.	2022-01-25T11:22:29Z
Description	string	The description of the backend service.	test
CreatedTime	string	The time when the backend service was created.	2022-01-25T11:22:29Z
BackendId	string	The ID of the backend service.	35bd31d32c9c425ebbe9330db9f8c375
Tags	array<object>	The list of tags.
	object
Key	string	The name of the tag.	groupName
Value	string	The value of the tag.	e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "090A0DF9-9144-5236-8CBA-E18DE317722D",
  "PageSize": 10,
  "TotalCount": 1,
  "BackendInfoList": [
    {
      "BackendName": "test",
      "BackendType": "HTTP",
      "ModifiedTime": "2022-01-25T11:22:29Z",
      "Description": "test",
      "CreatedTime": "2022-01-25T11:22:29Z",
      "BackendId": "35bd31d32c9c425ebbe9330db9f8c375",
      "Tags": [
        {
          "Key": "groupName",
          "Value": "e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.