文档

DescribePurchasedApiGroups - 获取购买的API分组列表

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

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

1
PageSizeinteger

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

20

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

本次请求的 ID。

36BBBAD4-1CFB-489F-841A-8CA52EEA787E
PageSizeinteger

每页数目。

20
TotalCountinteger

数据总条数。

2
PurchasedApiGroupAttributesobject []

采购的 API 分组属性

Statusstring

分组状态

  • NORMAL:正常
  • DELETE:删除
NORMAL
PurchasedTimestring

购买时间

2021-12-19T00:00:00
ExpireTimestring

失效时间

2021-12-19T00:00:00
Descriptionstring

分组描述

1
GroupNamestring

API 分组名称

group1
GroupIdstring

API 分组 ID

8e91f23f88f94348855b82c9a73209f3
InvokeTimesMaxlong

最大调用次数

10
InvokeTimesNowlong

当前调用次数

10
BillingTypestring

计费方式

POSTPAID
RegionIdstring

地域 ID。

cn-shanghai

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "36BBBAD4-1CFB-489F-841A-8CA52EEA787E",
  "PageSize": 20,
  "TotalCount": 2,
  "PurchasedApiGroupAttributes": {
    "PurchasedApiGroupAttribute": [
      {
        "Status": "NORMAL",
        "PurchasedTime": "2021-12-19T00:00:00",
        "ExpireTime": "2021-12-19T00:00:00",
        "Description": "1",
        "GroupName": "group1",
        "GroupId": "8e91f23f88f94348855b82c9a73209f3",
        "InvokeTimesMax": 10,
        "InvokeTimesNow": 10,
        "BillingType": "POSTPAID",
        "RegionId": "cn-shanghai"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈