使用DescribeDatasetList查询用户自定义数据集列表-API 网关-阿里云

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeDatasetList	get	Dataset `acs:apigateway:{#regionId}:{#accountId}:dataset/`	无	无

请求参数

名称	类型	必填	描述	示例值
DatasetIds	string	否	数据集 ID（支持输入多个数据集 ID，用","分隔）	4add6a61804e47858266883e********
DatasetName	string	否	插件数据集名称	IPwhitelist
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1
PageSize	integer	否	分页参数，每页显示条数，默认值 10	10
Tag	array<object>	否	指定规则所适用的对象标签，可设置多个
	object	否
Key	string	否	标签键	env
Value	string	否	标签值	value

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	D403C6E6-21B3-5B78-82DA-E3B6********
PageSize	integer	返回指定的每页条数	10
TotalCount	integer	返回结果的总条数	20
DatasetInfoList	array<object>	由 datasetinfo 组成的数组格式，返回数据集信息
DatasetInfo	object
DatasetId	string	数据集 ID	6304ce6b4ae6453f********
DatasetName	string	数据集名称	DatasetName
DatasetType	string	数据集类型，可选值： JWT_BLOCKING : JWT 黑名单 IP_WHITELIST_CIDR : IP 白名单 PARAMETER_ACCESS : 参数访问控制	IP_WHITELIST_CIDR
ModifiedTime	string	最后修改时间，格林威治时间	2022-09-21T12:58:43Z
CreatedTime	string	创建时间，格林威治时间	2022-09-21T12:58:43Z
Tags	array<object>	标签
TagInfo	object
Key	string	标签的键	ENV
Value	string	标签值	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
        }
      ],
      "Description": ""
    }
  ]
}

错误码

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

变更历史

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