GetAutoGroupingRule - Resource Management - Alibaba Cloud Documentation Center

Queries the information about a transfer rule.

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
resourcemanager:GetAutoGroupingRule	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RuleId	string	Yes	The ID of the rule.	gr-acfo******hy6a

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Rule	object	The information about the rule.
CreateTime	string	The time when the rule was created.	2025-01-01T10:00:00+08:00
ExcludeRegionIdsScope	string	The IDs of excluded regions. Multiple IDs are separated by commas (,).	cn-hangzhou,cn-shanghai
ExcludeResourceGroupIdsScope	string	The IDs of excluded resource groups. Multiple IDs are separated by commas (,).	rg-aekz****4b5ea,rg-aek2****fxykq
ExcludeResourceIdsScope	string	The IDs of excluded resources. Multiple IDs are separated by commas (,).	i-2zee****ym49kfmwis,vpc-5ts6****fnw493g849a
ExcludeResourceTypesScope	string	The excluded resource types. Multiple resource types are separated by commas (,).	ecs.instance,vpc.vpc
ModifyTime	string	The time when the rule was modified.	2025-01-01T10:00:00+08:00
RegionIdsScope	string	The IDs of regions. Multiple IDs are separated by commas (,).	cn-hangzhou,cn-shanghai
ResourceGroupIdsScope	string	The IDs of resource groups. Multiple IDs are separated by commas (,).	rg-aekz****4b5ea,rg-aek2****fxykq
ResourceIdsScope	string	The IDs of resources. Multiple IDs are separated by commas (,).	i-2zee****ym49kfmwis,vpc-5ts6****fnw493g849a
ResourceTypesScope	string	The resource types. Multiple resource types are separated by commas (,).	ecs.instance,vpc.vpc
RuleContents	array<object>	The content records of the rule.
RuleContent	object	The content record of the rule.
AutoGroupingScopeCondition	string	The condition for the range of resources that are automatically transferred.	{"children":[{"desired":"{\"env\":\"online\", \"project\":\"A\"}","featurePath":"$.tags","featureSource":"RESOURCE","operator":"TagMatchAll"}],"operator":"and"}
RuleContentId	string	The ID of the content record.	grc-acfo******fwybpq
TargetResourceGroupCondition	string	The condition for the destination resource group.	{"children":[{"desired":"rg-aek2********qcy","featurePath":"$.resourceGroupId","featureSource":"RESOURCE","operator":"StringEquals"}],"operator":"and"}
RuleDesc	string	The description of the rule.	Transfer resources to which the {"env": "online"} and {"project": "A"} tags are added to the resource group rg-aek2********qcy.
RuleId	string	The ID of the rule.	gr-acfo******hy6a
RuleName	string	The name of the rule.	Custom Transfer Rule for Online Resources of Project A
RuleType	string	The type of the rule. Valid values: custom_condition: custom transfer rule associated_transfer: transfer rule for associated resources	associated_transfer
RequestId	string	The request ID.	9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC

Examples

Sample success responses

JSONformat

{
  "Rule": {
    "CreateTime": "2025-01-01T10:00:00+08:00",
    "ExcludeRegionIdsScope": "cn-hangzhou,cn-shanghai\n",
    "ExcludeResourceGroupIdsScope": "rg-aekz******4b5ea,rg-aek2******fxykq\n",
    "ExcludeResourceIdsScope": "i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a",
    "ExcludeResourceTypesScope": "ecs.instance,vpc.vpc",
    "ModifyTime": "2025-01-01T10:00:00+08:00",
    "RegionIdsScope": "cn-hangzhou,cn-shanghai",
    "ResourceGroupIdsScope": "rg-aekz******4b5ea,rg-aek2******fxykq\n",
    "ResourceIdsScope": "i-2zee******ym49kfmwis,vpc-5ts6******fnw493g849a",
    "ResourceTypesScope": "ecs.instance,vpc.vpc",
    "RuleContents": [
      {
        "AutoGroupingScopeCondition": {
          "children": [
            {
              "desired": {
                "env": "online",
                "project": "A"
              },
              "featurePath": "$.tags",
              "featureSource": "RESOURCE",
              "operator": "TagMatchAll"
            }
          ],
          "operator": "and"
        },
        "RuleContentId": "grc-acfo******fwybpq",
        "TargetResourceGroupCondition": {
          "children": [
            {
              "desired": "rg-aek2********qcy",
              "featurePath": "$.resourceGroupId",
              "featureSource": "RESOURCE",
              "operator": "StringEquals"
            }
          ],
          "operator": "and"
        }
      }
    ],
    "RuleDesc": "Transfer resources to which the {\"env\": \"online\"} and {\"project\": \"A\"} tags are added to the resource group rg-aek2********qcy.",
    "RuleId": "gr-acfo******hy6a",
    "RuleName": "Custom Transfer Rule for Online Resources of Project A",
    "RuleType": "associated_transfer"
  },
  "RequestId": "9EA4F962-1A2E-4AFE-BE0C-B14736FC46CC"
}

Error codes

HTTP status code	Error code	Error message	Description
404	EntityNotExists.AutoGroupingRule	The specified rule is not found.	The specified rule is not found.
409	AutoGroupingNotEnabled	The auto grouping is disabled.	The auto grouping is disabled.

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