DescribeDatasetList - 查询数据集列表

查询用户自定义数据集列表。

调试

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

授权信息

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

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

请求参数

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

数据集 ID(支持输入多个数据集 ID,用","分隔)

4add6a61804e47858266883e********
PageNumberinteger

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

1
PageSizeinteger

分页参数,每页显示条数,默认值 10

10
Tagarray<object>

指定规则所适用的对象标签,可设置多个

object
Keystring

标签键

env
Valuestring

标签值

value

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

D403C6E6-21B3-5B78-82DA-E3B6********
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

20
DatasetInfoListarray<object>

由 datasetinfo 组成的数组格式,返回数据集信息

DatasetInfoobject
DatasetIdstring

数据集 ID

6304ce6b4ae6453f********
DatasetNamestring

数据集名称

DatasetName
DatasetTypestring

数据集类型,可选值:

  • JWT_BLOCKING : JWT 黑名单
  • IP_WHITELIST_CIDR : IP 白名单
  • PARAMETER_ACCESS : 参数访问控制
IP_WHITELIST_CIDR
ModifiedTimestring

最后修改时间,格林威治时间

2022-09-21T12:58:43Z
CreatedTimestring

创建时间,格林威治时间

2022-09-21T12:58:43Z
Tagsarray<object>

标签

TagInfoobject
Keystring

标签的键

ENV
Valuestring

标签值

123

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "D403C6E6-21B3-5B78-82DA-E3B6********",
  "PageSize": 10,
  "TotalCount": 20,
  "DatasetInfoList": [
    {
      "DatasetId": "6304ce6b4ae6453f********",
      "DatasetName": "DatasetName",
      "DatasetType": "IP_WHITELIST_CIDR",
      "ModifiedTime": "2022-09-21T12:58:43Z\n",
      "CreatedTime": "2022-09-21T12:58:43Z\n",
      "Tags": [
        {
          "Key": "ENV",
          "Value": "123"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情