CreateProtectionPolicy-阿里云帮助中心

Creates a 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:CreateProtectionPolicy

create

*All Resource

*

None

Request syntax

POST /api/v1/protection-policies HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate the value from your client to ensure that the value is unique among different requests. The ClientToken parameter supports only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.	a1b2c3d4-**--**-a1b2c3d4f5e6
ProtectionPolicyRegionId	string	Yes	The region ID of the protection policy.	cn-hangzhou
ProtectionPolicyName	string	Yes	The name of the protection policy.	My***Policy
BoundResourceCategoryIds	array	No	The IDs of the associated resource categories.
	string	No	The IDs of the associated resource categories.	rc-123**7890
SubProtectionPolicies	array<object>	Yes	The sub-protection policies.
	object	Yes	The sub-protection policies.
SubProtectionPolicyType	string	Yes	The type of the sub-protection policy.	ECS_AUTO_SNAPSHOT_POLICY
Config	string	No	The configuration of the sub-protection policy.	{'PlaybookUuid': '2093d1ea-0651-48a6-bea2-fa7157285dc1', 'ParamType': 'custom', 'InputParams': ''}

Response elements

Element	Type	Description	Example
	object	The response struct.
Data	object	The response data.
ProtectionPolicyId	string	The ID of the protection policy.	p-123***7890
RequestId	string	The unique identifier of the request.	34081B20-C4C0-514F-93F6-8EEC3D1A587E

Examples

Success response

JSON format

{
  "Data": {
    "ProtectionPolicyId": "p-123***7890"
  },
  "RequestId": "34081B20-C4C0-514F-93F6-8EEC3D1A587E"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.