DescribeDatasetList API to query custom datasets - API Gateway

Retrieves the list of custom datasets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribeDatasetList

get

*Dataset

acs:apigateway:{#regionId}:{#accountId}:dataset/*

None

Request parameters

Parameter	Type	Required	Description	Example
DatasetIds	string	No	Dataset IDs. You can specify multiple dataset IDs separated by commas (,).	4add6a61804e47858266883e********
DatasetName	string	No	Plugin dataset name	IPwhitelist
PageNumber	integer	No	The page number to query. Default is 1. Page numbering starts from 1.	1
PageSize	integer	No	Number of entries per page. Default is 10.	10
Tag	array<object>	No	Object tags that the rule applies to. You can specify multiple tags.
	object	No
Key	string	No	Tag key	env
Value	string	No	Tag value	value

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The returned page number	1
RequestId	string	Request ID	D403C6E6-21B3-5B78-82DA-E3B6********
PageSize	integer	The number of entries per page	10
TotalCount	integer	Total number of returned entries	20
DatasetInfoList	array<object>	An array of datasetinfo objects that contain dataset details
	array<object>
DatasetId	string	Dataset ID	6304ce6b4ae6453f********
DatasetName	string	Dataset name	DatasetName
DatasetType	string	Dataset type. Valid values: JWT_BLOCKING: JWT blacklist IP_WHITELIST_CIDR: IP address whitelist PARAMETER_ACCESS: Parameter access control	IP_WHITELIST_CIDR
ModifiedTime	string	Last modified time in UTC	2022-09-21T12:58:43Z
CreatedTime	string	Creation time in UTC	2022-09-21T12:58:43Z
Tags	array<object>	Tags
	object
Key	string	Tag key	ENV
Value	string	Tag value	123
Description	string

Examples

Success response

JSON format

{
  "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": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.