使用DescribeBackendList查询后端服务列表-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

查询后端服务列表，可以根据后端服务名称和后端服务类型进行过滤。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribeBackendList

get

*Backend

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

无

请求参数

名称	类型	必填	描述	示例值
BackendName	string	否	后端服务名称，支持使用*进行模糊查询。	test
BackendType	string	否	后端服务类型	HTTP
PageNumber	integer	否	分页参数：当前页码。	1
PageSize	integer	否	分页参数：每页显示条数。	10
Tag	array<object>	否	指定规则所适用的对象标签，可设置多个。
	object	否
Key	string	否	标签的 key	test1
Value	string	否	标签的值。	value

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	分页参数：当前页码。	1
RequestId	string	请求 ID。	090A0DF9-9144-5236-8CBA-E18DE317722D
PageSize	integer	分页参数：每页显示条数。	10
TotalCount	integer	总条数。	1
BackendInfoList	array<object>	后端服务列表
	array<object>
BackendName	string	后端服务名称	test
BackendType	string	后端服务类型	HTTP
ModifiedTime	string	后端服务修改时间	2022-01-25T11:22:29Z
Description	string	描述信息	test
CreatedTime	string	后端服务创建时间	2022-01-25T11:22:29Z
BackendId	string	后端服务 id	35bd31d32c9c425ebbe9330db9f8c375
Tags	array<object>	标签。
	object
Key	string	标签的 key	groupName
Value	string	标签的值。	e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。