Generates a resource non-compliance report.
Operation description
If you use the Tag Policy feature in single-account mode, you can call this API operation to generate a resource non-compliance report for the current logon account. If you use the Tag Policy feature in multi-account mode, you can call this API operation to generate a resource non-compliance report for the Root folder, a folder other than the Root folder, or a member in a resource directory. For more information about the modes of the Tag Policy feature, see Modes of the Tag Policy feature.
This topic provides an example on how to call this API operation to generate a resource non-compliance report for the current logon account. In this example, the Tag Policy feature in single-account mode is used.
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| tag:GenerateConfigRuleReport | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The region ID. Set the value to cn-shanghai. | cn-shanghai |
| TargetId | string | No | The ID of the object. | 154950938137**** |
| TargetType | string | No | The type of the object. Valid values:
Note
The value of this parameter is not case-sensitive.
| ACCOUNT |
| UserType | string | No | The mode of the Tag Policy feature. Valid values:
For more information about the modes of the Tag Policy feature, see Modes of the Tag Policy feature. Note
This parameter is required if the management account of your resource directory is used to enable the Tag Policy feature in both single-account mode and multi-account mode. The value of this parameter is not case-sensitive.
| USER |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "37B2AC06-89D8-5D95-98DF-3E68C12BDE05",
"ReportId": "crp-ao0786618088006c****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | GlobalAggregator.NotFount | Can not find global aggregator |
| 403 | NoPermission.Operator | Only the RD admin account has permission to operate |
| 403 | TagPolicy.NotOpen | You have not activated the tag policy service. |
| 403 | TagPolicy.PendingEnable | The tag policy status is pending enable. |
| 403 | WrongEndpoint | Only the shanghai endpoint supports the operation. |
For a list of error codes, visit the Service error codes.