Query Data Protection Rule Check Results via DescribeCheckDetails - BDRC - Alibaba Cloud - Backup and Disaster Recovery Center

Retrieves the check results for data protection rules.

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

bdrc:DescribeCheckDetails

none

*All Resource

*

None

Request syntax

GET /api/v1/check-details HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ResourceArn	string	Yes	The unique identifier of the resource.	acs:ecs:123*890:cn-shanghai:instance/i-001*90
RuleId	string	No	The unique ID of the data protection rule.	rule-000***dav
NextToken	string	No	The token that is used to retrieve the next page of results. Set this parameter to the value of NextToken that is returned from the last API call. For more information about how to set this parameter, see the API description.	cae**********699
MaxResults	integer	No	The maximum number of entries to return on each page. The default value is 10.	10

Response elements

Element	Type	Description	Example
	object	BaseResponse<ListResult>
Data	object	The data returned.
Content	array<object>	The collection of records returned by this request.
	object
ResourceArn	string	The globally unique Alibaba Cloud Resource Name (ARN) of the resource.	acs:ecs:123*890:cn-shanghai:instance/i-001*90
RuleId	string	The unique ID of the rule.	rule-xxxxxxxx
ProductType	string	The type of the cloud service.	ecs
ResourceType	string	The type of the resource.	ACS::ECS::Instance
ResourceId	string	The unique ID of the resource.	i-xxxxxxxx
ResourceName	string	The name of the resource.	test server
RuleTemplate	string	The rule template.	ecs-backup
CheckStatus	string	The check status. Valid values: NOT_CHECKED, PASSED, FAILED, CHECKING, and CHECK_FAILED.	PASSED
CheckTime	integer	The time when the check was performed.	1701725715
Detail	string	The check details.	{"ecsAutoSnapshotPolicyIds":[],"hbrBackupPlans":[{"planId":"po-xxxxxxxx","sourceType":"UDM_ECS"}]}
ResourceOwnerId	integer	The ID of the resource owner.	123***7890
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is empty, it indicates that all data has been retrieved.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=
MaxResults	integer	The maximum number of entries returned in this response.	10
TotalCount	integer	The total number of entries that meet the query conditions. This parameter is optional and is not returned by default.	100
RequestId	string	The unique ID of the request.	92793A50-0B97-59F1-BAEA-EAED83BA1998

Examples

Success response

JSON format

{
  "Data": {
    "Content": [
      {
        "ResourceArn": "acs:ecs:123***890:cn-shanghai:instance/i-001***90\n",
        "RuleId": "rule-xxxxxxxx",
        "ProductType": "ecs",
        "ResourceType": "ACS::ECS::Instance",
        "ResourceId": "i-xxxxxxxx",
        "ResourceName": "test server",
        "RuleTemplate": "ecs-backup",
        "CheckStatus": "PASSED",
        "CheckTime": 1701725715,
        "Detail": "{\"ecsAutoSnapshotPolicyIds\":[],\"hbrBackupPlans\":[{\"planId\":\"po-xxxxxxxx\",\"sourceType\":\"UDM_ECS\"}]}",
        "ResourceOwnerId": 0
      }
    ],
    "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=",
    "MaxResults": 10,
    "TotalCount": 100
  },
  "RequestId": "92793A50-0B97-59F1-BAEA-EAED83BA1998"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.