All Products
Search
Document Center

Elastic Compute Service:DescribeStorageSetDetails

Last Updated:Feb 04, 2024

Queries the details of the disks or Shared Block Storage devices in a storage set.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
RegionIdstringYes

The region ID of the storage set. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
StorageSetIdstringYes

The ID of the storage set.

ss-bp67acfmxazb4p****
StorageSetPartitionNumberintegerNo

The maximum number of partitions in the storage set.

3
DiskIdsstringNo

The IDs of disks or Shared Block Storage devices. The value can be a JSON array that consists of up to 100 disk or Shared Block Storage device IDs. Separate the IDs with commas (,).

["d-bp1d6tsvznfghy7y****", "d-bp1ippxbaql9zet7****", … "d-bp1ib7bcz07l****"]
PageNumberintegerNo

The number of the page to return.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

1
RequestIdstring

The ID of the request.

49765E79-0D5D-4451-B3AE-580A20831846
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of storage sets.

1
Disksobject []

Details about the disks or Shared Block Storage devices in the storage set.

CreationTimestring

The time when the disk or Shared Block Storage device was created.

2019-06-01T00:00:00Z
DiskNamestring

The name of the disk or Shared Block Storage device.

testDiskName
ZoneIdstring

The zone to which the disk or Shared Block Storage device belongs.

cn-hangzhou-g
StorageSetIdstring

The ID of the storage set.

ss-bp67acfmxazb4p****
DiskIdstring

The ID of the disk or Shared Block Storage device.

d-bp67acfmxazb4p****
Categorystring

The category of the disk or Shared Block Storage device.

cloud_ssd
StorageSetPartitionNumberinteger

The number of partitions in the storage set.

3
RegionIdstring

The region to which the disk or Shared Block Storage device belongs.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "RequestId": "49765E79-0D5D-4451-B3AE-580A20831846",
  "PageNumber": 1,
  "TotalCount": 1,
  "Disks": {
    "Disk": [
      {
        "CreationTime": "2019-06-01T00:00:00Z",
        "DiskName": "testDiskName",
        "ZoneId": "cn-hangzhou-g",
        "StorageSetId": "ss-bp67acfmxazb4p****",
        "DiskId": "d-bp67acfmxazb4p****",
        "Category": "cloud_ssd",
        "StorageSetPartitionNumber": 3,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

JSONformat

{
  "PageSize": 1,
  "RequestId": "49765E79-0D5D-4451-B3AE-580A20831846",
  "PageNumber": 1,
  "TotalCount": 1,
  "Disks": {
    "Disk": [
      {
        "CreationTime": "2019-06-01T00:00:00Z",
        "DiskName": "testDiskName",
        "ZoneId": "cn-hangzhou-g",
        "StorageSetId": "ss-bp67acfmxazb4p****",
        "DiskId": "d-bp67acfmxazb4p****",
        "Category": "cloud_ssd",
        "StorageSetPartitionNumber": 3,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidClientToken.ValueNotSupportedclienttoken is not valid.The specified ClientToken parameter is invalid.
403InvalidUser.NotSupported%sYour account does not support this operation.
403InvalidZone.NotSupported%s-
403InvalidZone.PartitionNumberNotSupported%s-
403InvalidStorageSetId.NotFound%s-
403InvalidStorageSet.NotSupport%s-
403InvalidRegionId.NotFound%sThe specified region ID does not exist.
403InvalidZoneId.NotFound%s-
403InvalidStorageSetName.Malformed%s-
403InvalidDescription.Malformed%s-
403InvalidMaxPartitionNumber.Malformed%s-
403InvalidParameter%sThe specified parameter is invalid.

For a list of error codes, visit the Service error codes.