Query ListProtectionPolicyApplications for Compliance Auditing - BDRC - Alibaba Cloud - Backup and Disaster Recovery Center

Retrieves the application history of the protection policy.

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:ListProtectionPolicyApplications

none

*All Resource

*

None

Request syntax

GET /api/v1/protection-policies/{ProtectionPolicyId}/list-applications HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ProtectionPolicyId	string	Yes	The ID of the protection policy.	p-123****890

Request parameters

Parameter	Type	Required	Description	Example
SubProtectionPolicyType	string	No	The sub-protection policy type.	ECS_AUTO_SNAPSHOT_POLICY
TaskId	string	Yes	The task ID. You can call the DescribeTasks operation to query task IDs.	t-0004d9ctt1ii********
NextToken	string	No	The pagination token. The response returns a `NextToken` value only when more results are available. To retrieve the next page, include the `NextToken` from the previous response in your request. If the response does not include a `NextToken` value, all results have been retrieved.	cae**********699
MaxResults	integer	No	The maximum number of results to return in a single page.	100
ResourceType	string	No	The resource type.	ACS::ECS::Instance
ApplyStatus	string	No	The application status.	FAILED

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	34081B20-C4C0-514F-93F6-8EEC3D1A587E
Data	object	The response data.
Content	array<object>	The response content.
	object	A policy application record.
ProtectionPolicyId	string	The protection policy ID.	p-123***7890
ResourceArn	string	The resource ARN.	acs:ecs:123*890:cn-shanghai:instance/i-001*90
ResourceId	string	The resource ID.	i-xxxxxxxx
ResourceType	string	The resource type.	ACS::ECS::Instance
ProductType	string	The product type.	ecs
SubProtectionPolicyType	string	The sub-protection policy type.	ECS_AUTO_SNAPSHOT_POLICY
TaskId	string	The task ID.	t-0000e4w0u1v592zdf6s7
ApplyTime	integer	The time the policy was applied.	2024-11-19T02:19:06Z
ApplyStatus	string	The policy application status.	FAILED
ApplyDetail	string	The error details, returned when the application fails.	{"errorCode":"HbrPolicyNotFound","errorMessage":"po-123***7890"}
ResourceOwnerId	integer		123***7890
NextToken	string	The pagination token for retrieving the next page of results. If this parameter is empty, all results have been returned.	fb836242f4225fa0f0e0257362dfc6dd
MaxResults	integer	The maximum number of results to return.	10
TotalCount	integer	The total number of entries.	5

Examples

Success response

JSON format

{
  "RequestId": "34081B20-C4C0-514F-93F6-8EEC3D1A587E",
  "Data": {
    "Content": [
      {
        "ProtectionPolicyId": "p-123***7890",
        "ResourceArn": "acs:ecs:123***890:cn-shanghai:instance/i-001***90\n",
        "ResourceId": "i-xxxxxxxx",
        "ResourceType": "ACS::ECS::Instance",
        "ProductType": "ecs",
        "SubProtectionPolicyType": "ECS_AUTO_SNAPSHOT_POLICY",
        "TaskId": "t-0000e4w0u1v592zdf6s7",
        "ApplyTime": 0,
        "ApplyStatus": "FAILED",
        "ApplyDetail": "{\"errorCode\":\"HbrPolicyNotFound\",\"errorMessage\":\"po-123***7890\"}",
        "ResourceOwnerId": 0
      }
    ],
    "NextToken": "fb836242f4225fa0f0e0257362dfc6dd",
    "MaxResults": 10,
    "TotalCount": 5
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.