All Products
Search

This Product

    Resource Management:GenerateConfigRuleReport

    Document Center

    Resource Management:GenerateConfigRuleReport

    Last Updated:Mar 03, 2024

    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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region ID. Set the value to cn-shanghai.

    		cn-shanghai
    TargetIdstringNo

    The ID of the object.

    		154950938137****
    TargetTypestringNo

    The type of the object. Valid values:

    • USER: the current logon account. This value is available if you use the Tag Policy feature in single-account mode.
    • ROOT: the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
    • FOLDER: a folder other than the Root folder in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
    • ACCOUNT: a member in a resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
    Note The value of this parameter is not case-sensitive.
    		ACCOUNT
    UserTypestringNo

    The mode of the Tag Policy feature. Valid values:

    • USER: single-account mode
    • RD: multi-account mode

    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

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		37B2AC06-89D8-5D95-98DF-3E68C12BDE05
    ReportIdstring

    The ID of the resource non-compliance report.

    		crp-ao0786618088006c****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "37B2AC06-89D8-5D95-98DF-3E68C12BDE05",
  "ReportId": "crp-ao0786618088006c****"
}

    Error codes

    HTTP status codeError codeError message
    400GlobalAggregator.NotFountCan not find global aggregator
    403NoPermission.Operator Only the RD admin account has permission to operate
    403TagPolicy.NotOpenYou have not activated the tag policy service.
    403TagPolicy.PendingEnableThe tag policy status is pending enable.
    403WrongEndpointOnly the shanghai endpoint supports the operation.

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