All Documents
Current Document

Recommend

Container Engine Virtual Private Cloud Standard Storage Service

Found 0 result in total

Content is empty

If you don't find the content you expect, please try another search term

Documentation

Elastic Block Storage (EBS)

View more results
Document title with current keyword not found
Directory
Expand AllFold All Up
No products found with this keyword
Documentation Elastic Block Storage (EBS) API Reference API operations for EBS volumes DescribeVolumes

DescribeVolumes

Last updated：2022-09-05 10:13:13

1. Description

You can call this operation to query details about one or more EBS volumes.

2. Request parameters

Parameter Type Required Description
VolumeId.N String No The ID of the EBS volume. For more information about how to specify this parameter, see the Examples section of this topic. The ID must be 36 characters in length and can contain letters, digits, and hyphens (-). If this parameter is not specified, all EBS volumes within your Kingsoft Cloud account are queried. You can specify up to 100 IDs. N ranges from 1 to 100.
VolumeCategory String No The category to which the EBS volume belongs. Valid values: system and data.
VolumeStatus String No The status of the EBS volume. Valid values: creating, available, attaching, in-use, detaching, extending, deleting, and error.
VolumeType String No Cloud disk type: ESSD_PL1/ESSD_PL2/ESSD_PL3/SSD3.0/EHDD.
VolumeCreateDate String No The date when the EBS volume was created, in the format of yyyy-MM-dd. You can specify this parameter to query EBS volumes that were created on the specified date.
Marker Integer No The pagination token, which indicates where to start in the response to the next call if not all entries are returned in the current call. Default value: 0.
MaxResults Integer No The maximum number of entries to return in one call. Value range: 10 to 1000. If the number of entries to return in one call exceeds 1000, 1000 is returned.
Maximum value: 1000.
Default value: 10.
Version String Yes The API version. Valid value: 2016-03-04.

3. Response parameters

Parameter Type Required Description
RequestId String Yes The request ID, which is unique. A request ID is returned for each request.
Volumes List No The list of information about the EBS volume. This parameter is not returned if no information is available.
VolumeId String No The ID of the EBS volume.
VolumeName String No The name of the EBS volume.
VolumeDesc String No The description of the EBS volume.
Size String No The capacity of the EBS volume, in GB.
VolumeStatus String No The status of the EBS volume. Valid values: creating, available, attaching, in-use, detaching, extending, deleting, and error.
VolumeType String No Cloud disk type: ESSD_PL1/ESSD_PL2/ESSD_PL3/SSD3.0/EHDD.
VolumeCategory String No The category to which the EBS volume belongs. Valid values: system and data.
InstanceId String No The ID of the KEC instance to which the EBS volume is attached when the EBS volume is in the in-use state.
CreateTime String No The time when the EBS volume was created.
ExpireTime String No The time when the EBS volume expires.
AvailabilityZone String No The availability zone in which the EBS volume resides.
ChargeType String No The billing mode of the EBS volume.
InstanceTradeType String No The order status of the EBS volume. Valid values: 1 (formal) and 2 (trial).
ProjectId Integer No The ID of the project to which the EBS volume belongs.
Attachment List No The current attachment information of the EBS volume.
InstanceId String No The ID of the KEC instance to which the EBS volume is currently attached.
MountPoint String No The mount point of the EBS volume.
DeleteWithInstance Boolean No Indicates whether the EBS volume is deleted when the KEC instance to which it is attached is deleted. Valid values:
true: indicates that the EBS volume is deleted when the KEC instance is deleted.
false: indicates that the EBS volume is detached from the KEC instance but is not deleted when the KEC instance is deleted.
HistoryAttachment List No The historical attachment information of the EBS volume.
InstanceId String No The ID of the KEC instance to which the EBS volume was attached.
AttachTime String No The local time when the EBS volume was attached to the KEC instance.
DetachTime String No The local time when the EBS volume was detached from the KEC instance.
MountPoint String No The historical local mount point of the EBS volume.
TotalCount Integer Yes The total number of EBS volumes that meet the criteria.
Marker Integer No The pagination token, which indicates where to start in the response to the next call if not all entries are returned in the current call. Default value: 0.
MaxResults Integer No The maximum number of entries returned in one call.

4. Examples

Request parameters

http://ebs.api.ksyun.com/
?Action=DescribeVolumes
&Version=2016-03-04
&VolumeType=SSD3.0
&VolumeStatus=in-use
&VolumeId.1=162460f4-176a-4729-9b6e-750e3fee13b2
&VolumeId.2=f66ca915-9ef2-416f-b025-3ce1c69d79f2
&VolumeId.3=534b90fb-26f4-4984-8ef6-8b61a460b7c4
&VolumeId.4=726375fb-3834-40b6-9a1d-24fa4542187f

Response parameters

{
    "RequestId": "ea82d72e-0169-4970-8beb-92d3a10964d7",
    "Volumes": [
        {
            "VolumeId": "162460f4-176a-4729-9b6e-750e3fee13b2",
            "VolumeName": "ebs1_system_disk",
            "VolumeDesc": "",
            "Size": 20,
            "VolumeStatus": "in-use",
            "VolumeType": "SSD3.0",
            "VolumeCategory": "system",
            "InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
            "AvailabilityZone": "cn-beijing-6a",
            "ChargeType": "Monthly",
            "InstanceTradeType": 1,
            "CreateTime": "2021-07-21 10:28:02",
            "Attachment": [
                {
                    "InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
                    "MountPoint": "/dev/vda",
                    "DeleteWithInstance": true
                }
            ],
            "ProjectId": 0,
            "ExpireTime": "2021-08-21 23:59:59"
        },
        {
            "VolumeId": "f66ca915-9ef2-416f-b025-3ce1c69d79f2",
            "VolumeName": "ebs1_data_disk",
            "Size": 100,
            "VolumeStatus": "in-use",
            "VolumeType": "SSD3.0",
            "VolumeCategory": "data",
            "InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
            "AvailabilityZone": "cn-beijing-6a",
            "ChargeType": "Monthly",
            "InstanceTradeType": 1,
            "CreateTime": "2021-06-15 22:09:58",
            "Attachment": [
                {
                    "InstanceId": "1e00e3ca-52e3-46d2-891d-e07088cfa2ea",
                    "MountPoint": "/dev/vdb",
                    "DeleteWithInstance": false
                }
            ],
            "ProjectId": 0,
            "ExpireTime": "2021-08-15 23:59:59"
        },
        {
            "VolumeId": "534b90fb-26f4-4984-8ef6-8b61a460b7c4",
            "VolumeName": "ebs2_system_disk",
            "VolumeDesc": "",
            "Size": 50,
            "VolumeStatus": "in-use",
            "VolumeType": "SSD3.0",
            "VolumeCategory": "system",
            "InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
            "AvailabilityZone": "cn-beijing-6c",
            "ChargeType": "Daily",
            "InstanceTradeType": 1,
            "CreateTime": "2021-07-09 13:33:03",
            "Attachment": [
                {
                    "InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
                    "MountPoint": "/dev/vda",
                    "DeleteWithInstance": true
                }
            ],
            "ProjectId": 0
        },
        {
            "VolumeId": "726375fb-3834-40b6-9a1d-24fa4542187f",
            "VolumeName": "ebs2_data_disk",
            "Size": 500,
            "VolumeStatus": "in-use",
            "VolumeType": "EHDD",
            "VolumeCategory": "data",
            "InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
            "AvailabilityZone": "cn-beijing-6c",
            "ChargeType": "Daily",
            "InstanceTradeType": 1,
            "CreateTime": "2021-05-08 14:38:11",
            "Attachment": [
                {
                    "InstanceId": "af585e94-3d37-4b6b-ac12-99b16f13c73c",
                    "MountPoint": "/dev/vdb",
                    "DeleteWithInstance": true
                }
            ],
            "HistoryAttachment": [
                {
                    "InstanceId": "5c49b207-04bd-427b-b60d-dc1dce96f933",
                    "AttachTime": "2021-05-08 14:40:05",
                    "DetachTime": "2021-05-08 17:02:58",
                    "MountPoint": "/dev/vdb"
                }
            ],
            "ProjectId": 0
        }
    ]
}
On this page
Previous:ResizeVolume
Next:ModifyVolume
Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen
Feedback