DescribeResourceGroups - Cloud Phone - Alibaba Cloud Documentation Center

Queries resource groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:DescribeResourceGroups	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupName	string	No	The name of the resource group.
ResourceGroupIds	array	No	The IDs of the resource groups that you want to query.
	string	No	The ID of the resource group that you want to query.	rg-9th3k8twp3ox2***
PageSize	integer	No	The number of entries per page.	20
PageNumber	integer	No	The page number. Pages start from page 1.	1
NeedContainResourceGroupWithOfficeSite	long	No	Note This parameter is not publicly available.	0
Platform	string	No	Note Set the value to AliyunConsole. This parameter is not publicly available on other platforms.	AliyunConsole

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	68BA1DF7-8814-5AED-B844-F8F7F7****
ResourceGroup	array<object>	The resource groups.
ResourceGroup	object	The resource group.
ResourceGroupId	string	The ID of the resource group.	rg-cyo0il2pzge1***
ResourceGroupName	string	The name of the resource group.
ResourceCount	string	The number of resources in the resource group.	119
AuthCount	string	The number of administrators that are authorized to access the resource group.	3
CreateTime	string	The time when the resource group was created.	2022-11-29T17:25:40.000000000Z
Policies	array<object>	Note The policy that is associated with the resource group. The policy applies to cloud computers in the resource group. If multiple policies exist, they are enforced in order of priority. If any of these cloud computers are already associated with other policies, the resource group's policy takes precedence.
Policy	object
Id	string	The policy ID.	pl-a8jnatl8kjasb***
Name	string	The policy name.
IsDefault	boolean	Specifies whether to use the default policy.	False
Timers	array<object>	Note The associated scheduled task. The scheduled task applies to all cloud computers in the resource group. If any of these cloud computers are already associated with other scheduled tasks, the resource group's scheduled task takes precedence.
Timer	object
Id	string	The ID of the scheduled task.	t-asdzx0mbjhg***
Name	string	The name of the scheduled task.
TotalCount	string	The total number of resource groups.	7

Examples

Sample success responses

JSONformat

{
  "RequestId": "68BA1DF7-8814-5AED-B844-F8F7F7****",
  "ResourceGroup": [
    {
      "ResourceGroupId": "rg-cyo0il2pzge1***",
      "ResourceGroupName": "",
      "ResourceCount": 119,
      "AuthCount": 3,
      "CreateTime": "2022-11-29T17:25:40.000000000Z",
      "Policies": [
        {
          "Id": "pl-a8jnatl8kjasb***",
          "Name": "",
          "IsDefault": true
        }
      ],
      "Timers": [
        {
          "Id": "t-asdzx0mbjhg***",
          "Name": "",
          "TimerStatus": "",
          "BindStatus": ""
        }
      ],
      "AppRules": [
        {
          "Id": "",
          "Name": "",
          "Type": 0
        }
      ]
    }
  ],
  "TotalCount": 7
}

Error codes

For a list of error codes, visit the Service error codes.