Call the DescribePlacementGroups API to query information about storage placement groups.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

request parameters

Below are the unique request parameters for this API and some common parameters. For more information, see Common Parameters.

Action string required Example: DescribePlacementGroups

The operation to be performed is: DescribePlacementGroups.

Version string required Example: 2020-04-01

The version of the API is: 2020-04-01.

ZoneId string Optional Sample value: cn-beijing-a

The availability zone where the storage placement group belongs.

Ids.N string[] Optional Example: pg-bp67acfmxazb4ph****

Storage placement group ID.

Name string Optional Example: test-pg

Enter the name of the placement group. Fuzzy search is supported.

PageNumber integer Optional Example: 1

Starting page number, default is 1.

PageSize integer Optional Example: 15

Page size, maximum is 100, default is 15.

Response Parameters

Below are the unique response parameters for this API. For more information, see Response Structure.

PlacementGroups object[] Example: -

Store the placement group information

Id string Example: pg-bp67acfmxazb4ph****

Storage Placement Group ID.

Name string Sample value: test-pg

Storage Placement Group Name

Description string Example: testDescription

Placement group description.

ZoneId string Example value: cn-beijing-a

Store the zone to which the placement group belongs.

SubgroupCount integer Example: 2

Number of storage sub-placement groups.

tip

The system automatically numbers placement groups in ascending order, starting at 1 and ending at the total number of placement groups.

AutoAssign boolean Example value: true

Enable the automatic assignment of storage sub-placement groups for the volume. When this feature is enabled, the placement group is bound when you create a volume, and storage sub-placement groups will be automatically assigned. Value descriptions are as follows:

true: Enable automatic assignment.

false: Do not enable automatic assignment.

CreatedAt string Example: 2023-07-05T15:48:58+08:00

Storage placement group creation time.

UpdatedAt string Example: 2023-07-05T15:48:58+08:00

Placement group update time.

PageNumber integer Example: 1

Number of Pages.

PageSize integer Sample value: 100

Page Size.

TotalCount integer Example: 3

Number of storage placement groups.

Request example

Back to example

error code

The table below lists the error codes related to this interface and its business logic. For public error codes, refer to the Public Error Code documentation.

Status code	error code	error message	Create Volume
500	ErrUnknown	unknown error	Unknown error.

Elastic Compute Service