DescribeBackendList

Updated at: 2025-03-06 03:38

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeBackendListget
*Backend
acs:apigateway:{#regionId}:{#accountId}:backend/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
BackendNamestringNo

The name of the backend service. You can use * to perform fuzzy queries.

test
BackendTypestringNo

The type of the backend service.

HTTP
PageNumberintegerNo

The number of the current page.

1
PageSizeintegerNo

The number of entries to return on each page.

10
Tagarray<object>No

The list of the tag.

objectNo
KeystringNo

The key of the tag.

test1
ValuestringNo

The value of the tag.

value

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
PageNumberinteger

The number of the current page.

1
RequestIdstring

The ID of the request.

090A0DF9-9144-5236-8CBA-E18DE317722D
PageSizeinteger

The number of entries returned on each page.

10
TotalCountinteger

The total number of entries returned.

1
BackendInfoListarray<object>

The backend services.

BackendInfoobject
BackendNamestring

The name of the backend service.

test
BackendTypestring

The type of the backend service.

HTTP
ModifiedTimestring

The time when the backend service was modified.

2022-01-25T11:22:29Z
Descriptionstring

The description of the backend service.

test
CreatedTimestring

The time when the backend service was created.

2022-01-25T11:22:29Z
BackendIdstring

The ID of the backend service.

35bd31d32c9c425ebbe9330db9f8c375
Tagsarray<object>

The list of tags.

TagInfoobject
Keystring

The name of the tag.

groupName
Valuestring

The value of the tag.

e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2023-11-09The request parameters of the API has changed. The response structure of the API has changedView Change Details
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare