Help Center/ Elastic Volume Service/ API Reference/ API/ Protection Group Management/ Creating a Protection Group

Updated on 2025-11-13 GMT+08:00

Online Debugging

CLI Examples

View PDF

Creating a Protection Group

Function

This API is used to create a protection group.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/security-protection-groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition The project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
security_protection_group	Yes	SecurityProtectionGroupRequestDetail object	Definition The information about the protection group. Constraints N/A Range N/A Default Value N/A

**Table 4** SecurityProtectionGroupRequestDetail
Parameter	Mandatory	Type	Description
name	Yes	String	Definition The protection group name. Constraints The value cannot be empty and can contain a maximum of 64 characters. Range N/A Default Value N/A
availability_zone	Yes	String	Definition The AZ of the protection group. You can call the Querying All AZs API or refer to Regions and Endpoints to obtain the AZ information. Constraints The value cannot be empty. It can contain a maximum of 128 characters, including only letters, digits, hyphens (-), underscores (_), and periods (.). Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
security_protection_group	SecurityProtectionGroupDetail object	Definition The information about the protection group. Range N/A

**Table 6** SecurityProtectionGroupDetail
Parameter	Type	Description
id	String	Definition The protection group ID. Range N/A
name	String	Definition The protection group name. Range N/A
availability_zone	String	Definition The AZ of the protection group. You can call the Querying All AZs API or refer to Regions and Endpoints to obtain the AZ information. Range N/A
protection_domains	Array of ProtectionDomainDetail objects	Definition The information about all protection domains in the protection group. Range N/A
created_at	String	Definition The time when the protection group was created. Range N/A
updated_at	String	Definition The time when the protection group was updated. Range N/A

**Table 7** ProtectionDomainDetail
Parameter	Type	Description
id	String	Definition The protection domain ID. Range N/A
name	String	Definition The protection domain name. Range The value is fixed at PD1, PD2, or PD3.
volume_count	Integer	Definition The number of disks in the protection domain. Range N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error	Error object	Definition The error information returned if an error occurs. Range N/A

**Table 9** Error
Parameter	Type	Description
code	String	Definition The error code returned if an error occurs. Range For details about the error code, see Error Codes.
message	String	Definition The error message returned if an error occurs. Range N/A

Example Requests

POST https://{endpoint}/v5/{project_id}/security-protection-groups

{
  "security_protection_group" : {
    "name" : "security-protection-group-001",
    "availability_zone" : "az1"
  }
}

Example Responses

Status code: 200

{
  "security_protection_group" : {
    "id" : "9ca00844-f8de-4184-9771-de792b728c28",
    "name" : "test_name",
    "availability_zone" : "az1.dc1",
    "protection_domains" : [ {
      "id" : "f96af29c-0212-4f94-a951-3b278ec6c776",
      "name" : "PD1",
      "volume_count" : 0
    }, {
      "id" : "cdb6c00a-b822-4733-bcb6-4b8b3479e8af",
      "name" : "PD2",
      "volume_count" : 0
    }, {
      "id" : "3a214fe1-6b5d-4b51-8376-2f1d4586741e",
      "name" : "PD3",
      "volume_count" : 0
    } ],
    "created_at" : "2025-06-30T09:34:44.483388",
    "updated_at" : "2025-06-30T09:34:44.488778"
  }
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "EVS.XXX"
  }
}

Status Codes

Status Code	Description
200	OK
400	Bad Request

Error Codes

See Error Codes.

Parent topic: Protection Group Management

Previous topic: Protection Group Management

Next topic: Listing Protection Groups

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot