文档

DescribeHistoryApis - 查询API发布版本定义列表

更新时间:

查询API历史发布版本列表。

调试

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

授权信息

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

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

请求参数

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

分组编号

0ccb66aadb5345b78a40f57d192d8aa4
StageNamestring

环境名称,可选值:

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

指定要查询的 Api 编号

a12068f555964ca8a0c9c33288f1e5a7
ApiNamestring

API 名称(模糊匹配)

getPersonInfo
PageSizestring

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

10
PageNumberstring

分页参数:当前页码。

2

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID。

6C87A26A-6A18-4B8E-8099-705278381A2C
PageSizeinteger

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

10
TotalCountinteger

返回结果的总条数

20
ApiHisItemsobject []

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

Statusstring

对应版本的 API 是否生效,取值为:ONLINEOFFLINE,分别表示有效、无效。

ONLINE
ApiIdstring

API 的 ID。

5af418828f0344a3b588c0cc1331a3bc
Descriptionstring

API 描述

创建对象接口
GroupNamestring

API 分组名称

myGroup2
GroupIdstring

API 分组 ID

1084f9034c744137901057206b39d2b6
DeployedTimestring

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

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

环境名称,可选值:

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

环境别名

线上
HistoryVersionstring

API 定义的历史版本

20210915101416294
ApiNamestring

API 名称

v2_role_assign
RegionIdstring

地域 ID

cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "6C87A26A-6A18-4B8E-8099-705278381A2C",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiHisItems": {
    "ApiHisItem": [
      {
        "Status": "ONLINE",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "Description": "创建对象接口",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "DeployedTime": "2016-07-20T08:28:48Z",
        "StageName": "RELEASE",
        "StageAlias": "线上",
        "HistoryVersion": "20210915101416294",
        "ApiName": "v2_role_assign",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)