文档

DescribeApisByBackend - 根据后端查询 API 列表

更新时间:

查询使用该后端服务创建的草稿态API,或已发布在某个环境上的API。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApisByBackendRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
BackendIdstring

后端服务 ID

4ac69b7a17524781b275ed4c5eb25c54
StageNamestring

指定要查询 API 的环境

  • RELEASE: 线上
  • PRE: 预发
  • TEST: 测试

不填写查询的是草稿态 API

PRE
PageSizeinteger

分页参数:每页显示条数。

10
PageNumberinteger

分页参数:当前页码。

1

返回参数

名称类型描述示例值
object
PageNumberinteger

分页参数:当前页码。

1
RequestIdstring

请求 ID

CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSizeinteger

分页参数:每页显示条数。

10
TotalCountinteger

总条数。

1
ApiInfoListobject []

返回的 API 列表信息

ApiIdstring

API 的 ID

20bcdc9453524b78a8beb1f6de21edb7
Descriptionstring

API 的描述信息

test
GroupNamestring

api 分组名称

testApiGroup
GroupIdstring

api 分组 ID

15bcdc9453524b7gs8beb1f6de21edb7
Pathstring

API 的请求路径

/test
Methodstring

API 的请求方法

GET
ApiNamestring

API 名称

testApi

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
  "PageSize": 10,
  "TotalCount": 1,
  "ApiInfoList": {
    "ApiInfo": [
      {
        "ApiId": "20bcdc9453524b78a8beb1f6de21edb7",
        "Description": "test",
        "GroupName": "testApiGroup",
        "GroupId": "15bcdc9453524b7gs8beb1f6de21edb7",
        "Path": "/test",
        "Method": "GET",
        "ApiName": "testApi"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)