Query Resource Categories with ListResourceCategories API - Backup and Disaster Recovery Center

Retrieves a list of resource categories.

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

bdrc:ListResourceCategories

none

*All Resource

*

None

Request syntax

GET /api/v1/resource-categories/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The maximum number of records to return in this request.	10
NextToken	string	No	The pagination token. If more entries are to be returned on the next page, a pagination token is returned. Note: If this parameter returns data, it indicates there is a next page. You can use the returned NextToken as a request parameter to obtain the next page of data until it returns Null, indicating all data has been retrieved.	cae**********699
ResourceCategoryId	string	No		rc-123****7890

Response elements

Element	Type	Description	Example
	object
Data	object	The returned data.
Content	array<object>	The collection of records returned in this request.
	object
ResourceCategoryId	string	The resource category ID, which is globally unique.	rc-123***7890
ResourceCategoryName	string	The resource name, which is unique within the namespace.	My***ResourceCategory
ResourceCategoryType	string	The resource category type. Valid values: DEFAULT: default group created by the system, cannot be deleted. CUSTOM: custom group, can be deleted.	CUSTOM
ProductType	string	The applicable product type. If this parameter is empty, all products are matched.	ecs
ResourceType	string	The applicable resource type. If this parameter is empty, all resources are matched.	ACS::ECS::Instance
ResourceMatcher	string	The resource matcher. If this parameter is empty, no resources are matched.	{\"type\":\"BOOL\",\"operator\":\"AND\",\"values\":[{\"type\":\"TAG\",\"key\":\"createdBy\",\"operator\":\"EQUAL\",\"values\":[\"me\"]}]}
ResourceCount	array<object>	The number of resources of each type.
	object
ResourceType	string	The resource type.	ACS::ECS::Instance
Count	integer	The number of resources of each type.	1
NextToken	string	Indicates the position where the current call returns data from. An empty value indicates that all data has been read.	eKDyCM0zFQ5op7jVMWmNNA==
MaxResults	integer	The maximum number of records returned in this request.	10
TotalCount	integer	The total number of data entries under the current request conditions. This parameter is optional and can be left unspecified by default.	5
RequestId	string	The unique ID of the request.	AE43C4CB-8074-5EBD-9806-8CA6D12800B1

Examples

Success response

JSON format

{
  "Data": {
    "Content": [
      {
        "ResourceCategoryId": "rc-123***7890",
        "ResourceCategoryName": "My***ResourceCategory",
        "ResourceCategoryType": "CUSTOM",
        "ProductType": "ecs",
        "ResourceType": "ACS::ECS::Instance",
        "ResourceMatcher": "{\\\"type\\\":\\\"BOOL\\\",\\\"operator\\\":\\\"AND\\\",\\\"values\\\":[{\\\"type\\\":\\\"TAG\\\",\\\"key\\\":\\\"createdBy\\\",\\\"operator\\\":\\\"EQUAL\\\",\\\"values\\\":[\\\"me\\\"]}]}",
        "ResourceCount": [
          {
            "ResourceType": "ACS::ECS::Instance",
            "Count": 1
          }
        ]
      }
    ],
    "NextToken": "eKDyCM0zFQ5op7jVMWmNNA==",
    "MaxResults": 10,
    "TotalCount": 5
  },
  "RequestId": "AE43C4CB-8074-5EBD-9806-8CA6D12800B1"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.