文档

DescribeDeployedApis - 查询已发布 API 列表

更新时间:

查询已经发布到某指定环境中的API列表,即查询指定环境中正在运行的API列表。

接口说明

  • 此功能面向开放 API 的用户

调试

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

授权信息

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

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

请求参数

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

指定的分组编号

63be9002440b4778a61122f14c2b2bbb
StageNamestring

环境名称,可选值:

  • RELEASE:线上
  • TEST:测试
RELEASE
ApiIdstring

指定的 API 编号

c076144d7878437b8f82fb85890ce6a0
ApiNamestring

API 名称(模糊匹配)

weather
PageNumberinteger

指定要查询的页码,默认是 1,起始是 1

1
PageSizeinteger

指定分页查询时每页行数,最大值 100,默认值为 10

10
EnableTagAuthboolean

是否启用标签验证

true
Tagobject []

标签列表。

Keystring

标签键

appname
Valuestring

标签值

testapp
ApiPathstring

API 的请求 Path

/st4
ApiMethodstring

API 的请求 HTTP 方法

POST

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ002
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

2
DeployedApisobject []

由 DeployedApiItem 组成的数组格式,返回 API 的信息

Visibilitystring

可见性,可选值:

  • PUBLIC: 公开
  • PRIVATE: 私有
PUBLIC
ApiIdstring

API 编号

c076144d7878437b8f82fb85890ce6a0
Descriptionstring

API 描述

分页显示对象列表
GroupNamestring

API 分组名称

myGroup3
GroupIdstring

API 分组编号

63be9002440b4778a61122f14c2b2bbb
DeployedTimestring

发布时间(格林威治时间)

2016-07-23T08:28:48Z
StageNamestring

环境名称,可选值:

  • RELEASE: 线上
  • TEST: 测试
RELEASE
ApiNamestring

API 名称

获取对象列表
RegionIdstring

所在的 region

cn-qingdao
ApiPathstring

API 的请求 Path

/trademark/search
ApiMethodstring

API 的请求 HTTP 方法

POST

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ002",
  "PageSize": 10,
  "TotalCount": 2,
  "DeployedApis": {
    "DeployedApiItem": [
      {
        "Visibility": "PUBLIC",
        "ApiId": "c076144d7878437b8f82fb85890ce6a0",
        "Description": "分页显示对象列表",
        "GroupName": "myGroup3",
        "GroupId": "63be9002440b4778a61122f14c2b2bbb",
        "DeployedTime": "2016-07-23T08:28:48Z",
        "StageName": "RELEASE",
        "ApiName": "获取对象列表",
        "RegionId": "cn-qingdao",
        "ApiPath": "/trademark/search",
        "ApiMethod": "POST"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-02OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ApiPath
    新增入参:ApiMethod
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)