All Products
Search

This Product

    Resource Management:GetConfigRuleReport

    Document Center

    Resource Management:GetConfigRuleReport

    Last Updated:Mar 03, 2024

    Queries the basic information about the resource non-compliance report that is last generated.

    Operation description

    If you use the Tag Policy feature in single-account mode, you can use the current logon account to call this API operation to query the basic information of the resource non-compliance report that is last generated for the account. If you use the Tag Policy feature in multi-account mode, you can use the management account of a resource directory to call this API operation to query the basic information of the resource non-compliance report that is last generated for an object in the resource directory. The object can be the Root folder, a folder other than the Root folder, or a member. 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 query the basic information of the resource non-compliance report that is last generated for the current logon account. In this example, the Tag Policy feature in single-account mode is used. The response shows that the ID of the report is crp-ao0786618088006c****.

    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****
    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 The value of this parameter is not case-sensitive.
    		USER
    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.
    		USER

    For more information about common request parameters, see Common parameters.

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		A68BD5BC-5B12-5A9B-8AE9-77884886BE10
    Successboolean

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.
    • false: The request fails.
    		true
    HttpStatusCodeinteger

    The HTTP status code.

    		200
    Dataobject

    The basic information of the resource non-compliance report that is last generated.

    ReportIdstring

    The ID of the report.

    		crp-ao0786618088006c****
    CreatedTimelong

    The time when the report was generated. This value is a UNIX timestamp.

    		1655089159000
    TargetIdstring

    The ID of the object.

    Note This parameter is returned if you set the TargetType and TargetId parameters in the current request to the same values as the parameters that are configured when you call the GenerateConfigRuleReport operation to generate the report.
    		154950938137****
    TargetTypestring

    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 the 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 the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
    • ACCOUNT: a member in the resource directory. This value is available if you use the Tag Policy feature in multi-account mode.
    Note This parameter is returned if you set the TargetType and TargetId parameters in the current request to the same values as the parameters that are configured when you call the GenerateConfigRuleReport operation to generate the report.
    		ACCOUNT

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "A68BD5BC-5B12-5A9B-8AE9-77884886BE10",
  "Success": true,
  "HttpStatusCode": 200,
  "Data": {
    "ReportId": "crp-ao0786618088006c****",
    "CreatedTime": 1655089159000,
    "TargetId": "154950938137****",
    "TargetType": "ACCOUNT"
  }
}

    Error codes

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