All Products
Search
Document Center

Cloud Config:DescribeRemediation

Last Updated:Jun 17, 2024

This topic provides an example on how to query the details of a remediation configuration whose ID is crr-f381cf0c1c2f004e\\*\\*\\*\\*.

Debugging

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

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 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.
OperationAccess levelResource typeCondition keyAssociated operation
config:DescribeRemediationRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdstringNo

The rule ID.

cr-3184626622af003****
RemediationIdstringNo

The ID of the remediation configuration.

crr-f381cf0c1c2f004e****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

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

The details of the remediation configuration.

LastSuccessfulInvocationTypestring

The mode of the last successful execution of the remediation template. Valid values:

  • NON_EXECUTION: The remediation template was not executed.
  • AUTO_EXECUTION: The remediation template was automatically executed.
  • MANUAL_EXECUTION: The remediation template was manually executed.
  • NOT_CONFIG: The execution mode was not specified.
AUTO_EXECUTION
RemediationTemplateIdstring

The ID of the remediation template.

ACS-OSS-PutBucketAcl
RemediationOriginParamsstring

The converted configuration of the remediation template. This parameter is returned only for an OOS remediation template.

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

The ID of the remediation configuration.

crr-f381cf0c1c2f004e****
RemediationSourceTypestring

The source of the remediation template. Valid values:

  • ALIYUN: official template
  • CUSTOM: custom template
  • NONE: none
ALIYUN
RemediationTypestring

The type of the remediation template. Valid values:

  • OOS: Operation Orchestration Service (official remediation)
  • FC: Function Compute (custom remediation)
OOS
LastSuccessfulInvocationIdstring

The record ID of the last successful execution of the remediation template.

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

The ID of the Alibaba Cloud account.

100931896542****
InvokeTypestring

The execution mode of the remediation template. Valid values:

  • NON_EXECUTION: The remediation template was not executed.
  • AUTO_EXECUTION: The remediation template was automatically executed.
  • MANUAL_EXECUTION: The remediation template was manually executed.
  • NOT_CONFIG: The execution mode was not specified.
AUTO_EXECUTION
ConfigRuleIdstring

The rule ID.

cr-3184626622af003****
LastSuccessfulInvocationTimelong

The timestamp of the last successful execution of the remediation template. Unit: milliseconds.

1625451393589

Examples

Sample success responses

JSONformat

{
  "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

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