All Products
Search
Document Center

Elastic Compute Service:DescribeDisksFullStatus

Last Updated:Sep 27, 2024

Queries the full status information about one or more Elastic Block Storage (EBS) devices.

Operation description

  • The full status information about an EBS device includes the lifecycle status specified by the Status parameter, health status specified by the HealthStatus parameter, and event type specified by the EventType parameter of the EBS device. You can filter the results based on these parameters.
  • The release time, scheduled execution time, and actual execution time of each EBS device event are identical. If you specify a period of time by using the EventTime.Start and EventTime.End parameters, all events that occurred within this period are queried. You can query events that occurred 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeDisksFullStatusget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
StatusstringNo

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

  • In_use: The EBS device is in use.
  • Available: The EBS device can be attached.
  • Attaching: The EBS device is being attached.
  • Detaching: The EBS device is being detached.
  • Creating: The EBS device is being created.
  • ReIniting: The EBS device is being initialized.
Available
HealthStatusstringNo

The health status of the EBS device. Valid values:

  • Impaired: The EBS device is damaged.
  • Warning: The performance of the EBS device is degraded.
  • Initializing: The EBS device is being initialized.
  • InsufficientData: The status cannot be determined due to insufficient data.
  • NotApplicable: The EBS device cannot be used.
Warning
EventTypestringNo

The event type of the EBS device. Valid values:

  • Degraded: The performance of the EBS device is degraded.
  • SeverelyDegraded: The performance of the EBS device is severely degraded.
  • Stalled: The performance of the EBS device is severely affected.
  • ErrorDetected: The local disk is damaged.
Stalled
EventTime.StartstringNo

The beginning of the time range to query occurred events.

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

2018-05-06T02:43:10Z
EventTime.EndstringNo

The end of the time range to query occurred events.

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

2018-05-08T02:48:52Z
PageNumberintegerNo

The page number. Pages start from page 1. The value must be a positive integer.

Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 100.

Default value: 10.

10
DiskIdarrayNo

The ID of EBS device N. Valid values of N: 1 to 100.

stringNo

The ID of EBS device N. Valid values of N: 1 to 100.

d-bp67acfmxazb4p****
EventIdarrayNo

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

stringNo

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

e-bp67acfmxazb4p****
ResourceGroupIdstringNo

The ID of the resource group to which the EBS device belongs. If you configure this parameter to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

rg-aek2kkmhmhs****
Tagarray<object>No

The tags to add to the EBS device.

objectNo

The tags to add to the EBS device.

KeystringNo

The key of tag N to add to the EBS device. A key-value pair consists of a key specified by the Tag.N.Key parameter and a value specified by the Tag.N.Value parameter. The two parameters are associated with each other. Valid values of N: 1 to 20.

Up to 1,000 resources with the specified tags can be returned in the response.

TestKey
ValuestringNo

The value of tag N to add to the EBS device. A key-value pair consists of a key specified by the Tag.N.Key parameter and a value specified by the Tag.N.Value parameter. The two parameters are associated with each other. Valid values of N: 1 to 20.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of EBS devices for which full status information is returned.

2
DiskFullStatusSetarray<object>

The collection of full status information of the EBS devices.

DiskFullStatusTypeobject
DiskIdstring

The EBS device ID.

d-bp67acfmxazb4p****
InstanceIdstring

The instance ID.

i-bp67acfmxazb4p****
Devicestring

The name of the EBS device that is attached to an instance. Example: /dev/xvdb.

This parameter has a value only when the value of Status is In_use.

Note This parameter will be deprecated in the future. To ensure future compatibility, we recommend that you do not use this parameter.
null
DiskEventSetarray<object>

The events about the EBS device.

DiskEventTypeobject
EventIdstring

The ID of the event.

e-bp67acfmxazb4p****
EventEndTimestring

The time when the event ended.

2018-05-06T02:48:52Z
EventTimestring

The time when the event occurred.

2018-05-08T02:43:10Z
ImpactLevelstring

The impact level of the event.

100
EventTypeobject

The type of the event.

Namestring

The name of the event type. Valid values:

  • Degraded: The performance of the EBS device is degraded.
  • SeverelyDegraded: The performance of the EBS device is severely degraded.
  • Stalled: The performance of the EBS device is severely affected.
  • ErrorDetected: The local disk is damaged.
Stalled
Codeinteger

The code of the event type.

7
Statusobject

The lifecycle status of the EBS device.

Namestring

The name of the lifecycle status of the EBS device.

Available
Codeinteger

The code of the lifecycle status of the EBS device.

129
HealthStatusobject

The health status of the EBS device.

Namestring

The name of the health status of the EBS device.

Impaired
Codeinteger

The code of the health status of the EBS device.

128

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "DiskFullStatusSet": {
    "DiskFullStatusType": [
      {
        "DiskId": "d-bp67acfmxazb4p****",
        "InstanceId": "i-bp67acfmxazb4p****",
        "Device": "null",
        "DiskEventSet": {
          "DiskEventType": [
            {
              "EventId": "e-bp67acfmxazb4p****",
              "EventEndTime": "2018-05-06T02:48:52Z",
              "EventTime": "2018-05-08T02:43:10Z",
              "ImpactLevel": "100",
              "EventType": {
                "Name": "Stalled",
                "Code": 7
              }
            }
          ]
        },
        "Status": {
          "Name": "Available",
          "Code": 129
        },
        "HealthStatus": {
          "Name": "Impaired",
          "Code": 128
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403InvalidParameter%sThe specified parameter is invalid.
403DiskIdLimitExceeded%sMore than 100 disk IDs are specified.
403EventIdLimitExceeded%sMore than 100 simulated event IDs are specified.
403InvalidParameter.TimeEndBeforeStart%sThe specified parameter is invalid. Make sure that the end time is later than the start time.
403OperationDenied.NotInWhiteList%sYou are not authorized to perform this operation. Try again when you are authorized.
403TooManyDiskEvent.DiskIdRequired%sThe system cannot process this number of requests for the specified resource. Try again later.
404MissingParameter%sA parameter is not specified.

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

Change history

Change timeSummary of changesOperation
No change history