All Products
Search

This Product

    Cloud Config:DescribeRemediation

    Document Center

    Cloud Config:DescribeRemediation

    Last Updated:Sep 02, 2026

    Provides an example of querying the details of remediation setting crr-f381cf0c1c2f004e****.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    config:DescribeRemediation

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ConfigRuleId

    string

    No

    The rule ID. You must specify at least one of ConfigRuleId and RemediationId to identify an existing remediation setting.

    cr-3184626622af003****
    RemediationId

    string

    No

    The remediation setting ID. You can call ListRemediations to obtain the ID. If you have not created a remediation setting, call ListConfigRules to obtain rules, call ListRemediationTemplates with the ManagedRuleIdentifier filter to obtain compatible templates, call CreateRemediation to create a remediation setting, and then call DescribeRemediation to query the setting. You must specify at least one of ConfigRuleId and RemediationId.

    crr-f381cf0c1c2f004e****

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    79BE07A7-46A5-5D3C-B378-0ACDA979****
    Remediation

    object

    The details of the remediation setting.

    LastSuccessfulInvocationType

    string

    The method of the last successful remediation execution. Valid values:

    • NON_EXECUTION: Not executed.

    • AUTO_EXECUTION: Automatically executed.

    • MANUAL_EXECUTION: Manually executed.

    • NOT_CONFIG: Not configured.

    AUTO_EXECUTION
    RemediationTemplateId

    string

    The remediation template ID.

    ACS-OSS-PutBucketAcl
    RemediationOriginParams

    string

    The converted format of the remediation setting parameters. This parameter is used only to convert the parameters of OOS templates.

    {"bucketName": "{resourceId}", "regionId": "{regionId}", "permissionName": "private"}
    RemediationId

    string

    The remediation setting ID.

    crr-f381cf0c1c2f004e****
    RemediationSourceType

    string

    The source of the template used for remediation. Valid values:

    • ALIYUN: China site template.

    • CUSTOM: Custom template.

    • NONE: None.

    ALIYUN
    RemediationType

    string

    The remediation type. Valid values:

    • OOS: CloudOps Orchestration Service (official remediation).

    • FC: Function Compute (custom remediation).

    OOS
    LastSuccessfulInvocationId

    string

    The record ID of the last successful remediation execute.

    bd7629fb-cac8-42fe-bcb1-e362c5a6****
    AccountId

    integer

    The Alibaba Cloud account ID.

    100931896542****
    InvokeType

    string

    The remediation execution method. Valid values:

    • NON_EXECUTION: Not executed.

    • AUTO_EXECUTION: Automatically executed.

    • MANUAL_EXECUTION: Manually executed.

    • NOT_CONFIG: Settings not configured.

    AUTO_EXECUTION
    ConfigRuleId

    string

    The rule ID.

    cr-3184626622af003****
    LastSuccessfulInvocationTime

    integer

    The UNIX timestamp when the remediation was last successfully executed. Unit: milliseconds.

    1625451393589

    Examples

    Success response

    JSON format

    {
  "RequestId": "79BE07A7-46A5-5D3C-B378-0ACDA979****",
  "Remediation": {
    "LastSuccessfulInvocationType": "AUTO_EXECUTION",
    "RemediationTemplateId": "ACS-OSS-PutBucketAcl",
    "RemediationOriginParams": "{\"bucketName\": \"{resourceId}\", \"regionId\": \"{regionId}\", \"permissionName\": \"private\"}",
    "RemediationId": "crr-f381cf0c1c2f004e****",
    "RemediationSourceType": "ALIYUN",
    "RemediationType": "OOS",
    "LastSuccessfulInvocationId": "bd7629fb-cac8-42fe-bcb1-e362c5a6****",
    "AccountId": 0,
    "InvokeType": "AUTO_EXECUTION",
    "ConfigRuleId": "cr-3184626622af003****",
    "LastSuccessfulInvocationTime": 1625451393589
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.