调用DescribePurchasedApis获取购买的API列表_API 网关(API Gateway)-阿里云帮助中心

获取在云市场购买的 API 列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribePurchasedApis	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	否	分组编号	d27ad517be5f4c95ac3631780a8f4d50
StageName	string	否	指定要操作 API 的环境。 RELEASE: 线上 PRE: 预发 TEST: 测试	RELEASE
ApiId	string	否	API 编号	3b81fd160f5645e097cc8855d75a1cf6
ApiName	string	否	API 名称	纯真IP库查询接口
Visibility	string	否	API 是否公开，目前可以取值： PUBLIC：公开，如选择此类型，该 API 的线上环境，会在所有用户的控制台“发现 API”页面展示 PRIVATE：不公开，如选择此类型，当该组 API 在云市场上架时，私有类型的 API 不会上架	PUBLIC
PageSize	integer	否	每页条目	10
PageNumber	integer	否	返回指定的页码	1

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	当前页的页码。	1
RequestId	string	本次请求的 ID。	CE5722A6-AE78-4741-A9B0-6C817D360510
PageSize	integer	每页条目	10
TotalCount	integer	返回结果的总条数	20
PurchasedApis	object []	由 purchasedapi 组成的数组格式，返回 api 调用延迟监控信息
Visibility	string	可见性，可选值： PUBLIC：公开 PRIVATE：私有	PUBLIC
PurchasedTime	string	购买时间	2021-06-11T13:57:38+08:00
ApiId	string	API 的 ID。	eb6e54c1576d41149746e8e69b0a0792
ModifiedTime	string	最后修改时间，格林威治时间	2021-06-11T13:57:38+08:00
Description	string	API 描述	test测试
GroupName	string	API 分组名称	DMS_DEFAULT_GROUP_408589
GroupId	string	API 分组 ID，系统生成，全局唯一	3013a55c0c44483f984d26df27120513
DeployedTime	string	部署时间，格式为 yyyy-mm-ddhh:mm:ss	2021-06-1113:57:38
StageName	string	指定要操作 API 的环境。 RELEASE: 线上 PRE: 预发 TEST: 测试	TEST
ApiName	string	API 名称	gw_rado_tissot_
RegionId	string	地域 ID。	cn-hangzhou

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CE5722A6-AE78-4741-A9B0-6C817D360510",
  "PageSize": 10,
  "TotalCount": 20,
  "PurchasedApis": {
    "PurchasedApi": [
      {
        "Visibility": "PUBLIC",
        "PurchasedTime": "2021-06-11T13:57:38+08:00",
        "ApiId": "eb6e54c1576d41149746e8e69b0a0792",
        "ModifiedTime": "2021-06-11T13:57:38+08:00",
        "Description": "test测试",
        "GroupName": "DMS_DEFAULT_GROUP_408589",
        "GroupId": "3013a55c0c44483f984d26df27120513",
        "DeployedTime": "2021-06-1113:57:38",
        "StageName": "TEST",
        "ApiName": "gw_rado_tissot_",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史