Help Center/ Elastic Volume Service/ API Reference/ API/ Protection Group Management/ Querying a Protection Group
Updated on 2025-11-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Protection Group

Function

This API is used to query 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

GET /v5/{project_id}/security-protection-groups/{security_protection_group_id}

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

security_protection_group_id

Yes

String

Definition

The protection group ID.

You can call the Listing Protection Groups API to obtain the desired protection group 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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

security_protection_group

SecurityProtectionGroupDetail object

Definition

The information about the protection group.

Range

N/A
Table 4 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 5 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 6 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error information returned if an error occurs.

Range

N/A
Table 7 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

None

Example Responses

Status code: 200

OK

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