You can call this operation to query the full status information of one or more Block Storage devices.

Description

  • The full status information of Block Storage devices consists of the lifecycle (Status), health status (HealthStatus), and event type (EventType) of the Block Storage devices.
  • The release time, scheduled execution time, and actual execution time of Block Storage devices are the same. If you specify a time period (EventTime.Start to EventTime.End), the system can query all events that occurred during this time period. You can query events within the last seven days.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-hangzhou

The region ID of the Block Storage device.

You can call the DescribeRegions operation to query the most recent region list.

Action String Yes DescribeDisksFullStatus

The operation that you want to perform. Set the value to DescribeDisksFullStatus.

DiskId.N RepeatList No d-disk1

The ID of the Block Storage device. Valid values of N: 1 to 100.

EventId.N RepeatList No e-event1

The ID of the event. Valid values of N: 1 to 100.

EventTime.End String No 2018-05-08T02:48:52Z

The end time of events to be queried.

Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

EventTime.Start String No 2018-05-06T02:43:10Z

The start time of events to be queried.

Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

EventType String No Stalled

The event type of the Block Storage device. Valid values:

  • Degraded: The performance of the Block Storage device is degraded.
  • SeverelyDegraded: The performance of the Block Storage device is severely degraded.
  • Stalled: The performance of the Block Storage device is severely affected.
HealthStatus String No Warning

The health status of the Block Storage device. Valid values:

  • Impaired: The performance of the Block Storage device is damaged.
  • Warning: The performance of the Block Storage device may be degraded because of maintenance or technical issues.
  • Initializing: The Block Storage device is being initialized.
  • InsufficientData: The status cannot be determined because of insufficient data.
  • NotApplicable: The parameter is not applicable.
PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 100.

Default value: 10.

Status String No Available

The lifecycle status of the Block Storage device. For more information, see Disk status. Valid values:

  • In_Use
  • Available
  • Attaching
  • Detaching
  • Creating
  • ReIniting

Response parameters

Parameter Type Example Description
DiskFullStatusSet Array

An array consisting of full status of the Block Storage device.

DiskFullStatusType

The status type of the Block Storage device.

Device String null

The device name of the Block Storage device that is attached to an instance, such as /dev/xvdb.

This parameter is empty unless Status is set to In_use.

Note This parameter will be removed in the future. We recommend that you use other parameters to ensure future compatibility.
DiskEventSet Array

An array consisting of Block Storage event data.

DiskEventType

The event type of the Block Storage device.

EventEndTime String 2018-05-06T02:48:52Z

The time when the event ended.

EventId String e-event1

The ID of the Block Storage event.

EventTime String 2018-05-08T02:43:10Z

The time when the event occurred.

EventType

The type of the event.

Code Integer 7

The code of the event type.

Name String Stalled

The name of the event type.

DiskId String d-disk1

The ID of the Block Storage device.

HealthStatus

The health status of the Block Storage device.

Code Integer 128

The code of the Block Storage health status.

Name String Impaired

The name of the Block Storage health status.

InstanceId String i-instance1

The ID of the instance.

Status

The lifecycle status of the Block Storage device.

Code Integer 129

The code of the lifecycle status of the Block Storage device.

Name String Available

The name of the lifecycle status of the Block Storage device.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 2

The total number of full statuses of the Block Storage device.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeDisksFullStatus
&RegionId=cn-hangzhou
&DiskId.1=d-disk1
&EventId.1=e-event1
&Status=Available
&HealthStatus=Warning
&EventType=Stalled
&EventTime.Start=2018-05-06T02:43:10Z
&EventTime.End=2018-05-08T02:48:52Z
&PageNumber=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

<DescribeDisksFullStatusResponse>
      <DiskFullStatusSet>
            <DiskFullStatusType>
                  <DiskEventSet>
                        <DiskEventType>
                              <EventId>e-bp67acfmxazb4ph***</EventId>
                              <EventType>
                                    <Code>7</Code>
                                    <Name>Stalled</Name>
                              </EventType>
                              <EventTime>2018-05-08T02:43:10Z</EventTime>
                        </DiskEventType>
                  </DiskEventSet>
                  <DiskId>d-bp67acfmxazb4ph***</DiskId>
                  <InstanceId>i-bp67acfmxazb4ph***</InstanceId>
                  <Device>/dev/xvda</Device>
                  <HealthStatus>
                        <Code>128</Code>
                        <Name>Impaired</Name>
                  </HealthStatus>
                  <Status>
                        <Code>129</Code>
                        <Name>Available</Name>
                  </Status>
            </DiskFullStatusType>
            <DiskFullStatusType>
                  <DiskEventSet>
                        <DiskEventType>
                              <EventId>e-bp67acfmxazb4ph***</EventId>
                              <EventType>
                                    <Code>1</Code>
                                    <Name>Degraded</Name>
                              </EventType>
                              <EventTime>2018-05-06T02:43:10Z</EventTime>
                              <EventEndTime>2018-05-06T02:48:52Z</EventEndTime>
                        </DiskEventType>
                  </DiskEventSet>
                  <DiskId>d-disk2</DiskId>
                  <InstanceId>i-instance2</InstanceId>
                  <Device>/dev/xvdb</Device>
                  <HealthStatus>
                        <Code>64</Code>
                        <Name>Warning</Name>
                  </HealthStatus>
                  <Status>
                        <Code>0</Code>
                        <Name>Ok</Name>
                  </Status>
            </DiskFullStatusType>
      </DiskFullStatusSet>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <RequestId>1A8B4B27-8B2D-XXXX-XXXX-0F64DBE4C211</RequestId>
      <TotalCount>2</TotalCount>
</DescribeDisksFullStatusResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":2,
	"PageSize":10,
	"RequestId":"1A8B4B27-8B2D-XXXX-XXXX-0F64DBE4C211",
	"DiskFullStatusSet":{
		"DiskFullStatusType":[
			{
				"Status":{
					"Name":"Available",
					"Code":129
				},
				"Device":"/dev/xvda",
				"HealthStatus":{
					"Name":"Impaired",
					"Code":128
				},
				"InstanceId":"i-bp67acfmxazb4ph***",
				"DiskEventSet":{
					"DiskEventType":[
						{
							"EventTime":"2018-05-08T02:43:10Z",
							"EventId":"e-bp67acfmxazb4ph***",
							"EventType":{
								"Name":"Stalled",
								"Code":"7"
							}
						}
					]
				},
				"DiskId":"d-bp67acfmxazb4ph***"
			},
			{
				"Status":{
					"Name":"Available",
					"Code":129
				},
				"Device":"/dev/xvdb",
				"HealthStatus":{
					"Name":"Ok",
					"Code":0
				},
				"InstanceId":"i-instance2",
				"DiskEventSet":{
					"DiskEventType":[
						{
							"EventTime":"2018-05-06T02:43:10Z",
							"EventId":"e-bp67acfmxazb4pi***",
							"EventType":{
								"Name":"Degraded",
								"Code":"1"
							},
							"EventEndTime":"2018-05-06T02:48:52Z"
						}
					]
				},
				"DiskId":"d-disk2"
			}
		]
	}
}

Error codes

HTTP status code Error code Error message Description
404 MissingParameter %s The error message returned because a required parameter is not specified.
403 InvalidParameter %s The error message returned because the specified parameter is invalid.
403 DiskIdLimitExceeded %s The error message returned because the number of the specified disk IDs exceeds 100.
403 EventIdLimitExceeded %s The error message returned because more than 100 system event IDs are specified.
403 InvalidParameter.TimeEndBeforeStart %s The error message returned because the end time was earlier the start time.
403 OperationDenied.NotInWhiteList %s The error message returned because you are not authorized to perform this operation.
403 TooManyDiskEvent.DiskIdRequired %s The error message returned because the number of disk events is beyond the query range. Specify the DiskId parameter to query disk events.

For a list of error codes, visit the API Error Center.