DescribeDisksFullStatus-阿里云帮助中心

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeDisksFullStatus

list

Disk

acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}

Disk

acs:ecs:{#regionId}:{#accountId}:disk/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the EBS device. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
RegionId	string	Yes	The region ID of the EBS device. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Status	string	No	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
HealthStatus	string	No	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
EventType	string	No	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.Start	string	No	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.End	string	No	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
PageNumber	integer	No	The page number. Pages start from page 1. The value must be a positive integer. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
DiskId	array	No	The ID of EBS device N. Valid values of N: 1 to 100.	d-bp67acfmxazb4p****
	string	No	The ID of EBS device N. Valid values of N: 1 to 100.	d-bp67acfmxazb4p****
EventId	array	No	The ID of event N. Valid values of N: 1 to 100.	e-bp67acfmxazb4p****
	string	No	The ID of event N. Valid values of N: 1 to 100.	e-bp67acfmxazb4p****
ResourceGroupId	string	No	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****
Tag	array<object>	No	The tags to add to the EBS device.
	object	No	The tags to add to the EBS device.
Key	string	No	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
Value	string	No	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 elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of EBS devices for which full status information is returned.	2
DiskFullStatusSet	object
DiskFullStatusType	array<object>	The collection of full status information of the EBS devices.
	array<object>
DiskId	string	The EBS device ID.	d-bp67acfmxazb4p****
InstanceId	string	The instance ID.	i-bp67acfmxazb4p****
Device	string	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
DiskEventSet	object
DiskEventType	array<object>	The events about the EBS device.
	array<object>
EventId	string	The ID of the event.	e-bp67acfmxazb4p****
EventEndTime	string	The time when the event ended.	2018-05-06T02:48:52Z
EventTime	string	The time when the event occurred.	2018-05-08T02:43:10Z
ImpactLevel	string	The impact level of the event.	100
EventType	object	The type of the event.
Name	string	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
Code	integer	The code of the event type.	7
Status	object	The lifecycle status of the EBS device.
Name	string	The name of the lifecycle status of the EBS device.	Available
Code	integer	The code of the lifecycle status of the EBS device.	129
HealthStatus	object	The health status of the EBS device.
Name	string	The name of the health status of the EBS device.	Impaired
Code	integer	The code of the health status of the EBS device.	128

Examples

Success response

JSON format

{
  "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 response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter	%s
403	DiskIdLimitExceeded	%s	More than 100 disk IDs are specified.
403	EventIdLimitExceeded	%s
403	InvalidParameter.TimeEndBeforeStart	%s	The specified parameter is invalid. Make sure that the end time is later than the start time.
403	OperationDenied.NotInWhiteList	%s	You are not authorized to perform this operation. Try again when you are authorized.
403	TooManyDiskEvent.DiskIdRequired	%s	The system cannot process this number of requests for the specified resource. Try again later.
404	MissingParameter	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.