GetResourceCategory API Reference & Resource Category Structure - BDRC

Retrieves a single resource category.

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:GetResourceCategory

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ResourceCategoryId	string	Yes	Resource category ID.	rc-123***7890

Response elements

Element	Type	Description	Example
	object
Data	object	The returned data.
ResourceCategoryId	string	Resource category ID, globally unique.	rc-123***7890
ResourceCategoryName	string	Resource name, unique within the namespace.	My***ResourceCategory
ResourceCategoryType	string	Resource category type. Valid values: DEFAULT: default group, created by the system, cannot be deleted. CUSTOM: custom group, can be deleted.	CUSTOM
ProductType	string	Applicable product type. If empty, matches all products.	ecs
ResourceType	string	Applicable resource type. If empty, matches all resources.	ACS::ECS::Instance
ResourceMatcher	string	Resource matcher. If empty, no resources are matched.	{\"type\":\"BOOL\",\"operator\":\"AND\",\"values\":[{\"type\":\"TAG\",\"key\":\"createdBy\",\"operator\":\"EQUAL\",\"values\":[\"me\"]}]}
ResourceCount	array<object>	Number of resources by type.
	object
ResourceType	string	Resource type.	ACS::ECS::Instance
Count	integer	Number of resources by type.	1
RequestId	string	The unique ID of the request.	AE43C4CB-8074-5EBD-9806-8CA6D12800B1

Examples

Success response

JSON format

{
  "Data": {
    "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
      }
    ]
  },
  "RequestId": "AE43C4CB-8074-5EBD-9806-8CA6D12800B1"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.