Consulta dispositivos de block storage creados, incluidos discos en la nube y discos locales.
Notas de uso
Configure varios parámetros de solicitud como RegionId, ZoneId, DiskIds e InstanceId para usarlos como filtros. Los parámetros configurados se evalúan mediante el operador "AND". Si especifica más de un filtro, se devuelven los registros que coinciden con todos ellos.
El valor del parámetro DiskIds es una matriz JSON. Si no se configura el parámetro DiskIds, no se utiliza como filtro. Si el parámetro DiskIds se establece en una matriz JSON vacía, se considera un filtro válido y se devuelve un resultado vacío.
-
Utilice uno de los siguientes métodos para revisar las respuestas:
Método 1: Use NextToken para configurar el token de consulta. Establezca el valor en el valor de NextToken devuelto en la última llamada a la operación DescribeDisks. Luego, use MaxResults para especificar el número máximo de entradas por página.
-
Método 2: Configure el parámetro PageSize para especificar el número de entradas por página y configure el parámetro PageNumber para indicar el número de página a devolver.
Solo puede utilizar uno de los métodos anteriores. Si se van a devolver muchas entradas, se recomienda usar el Método 1. Si se configura el parámetro NextToken, los parámetros PageSize y PageNumber no surten efecto y el parámetro TotalCount en la respuesta no es válido.
Un disco en la nube con la función de montaje múltiple habilitada puede conectarse a varias instancias. Consulte la información de conexión del disco en la nube según los valores de Attachment en la respuesta.
Al llamar a una operación de API mediante Alibaba Cloud CLI, debe especificar los valores de los parámetros de solicitud de distintos tipos de datos en los formatos requeridos. Para obtener más información, consulte Parameter format overview.
Depuración
Parámetros de solicitud
Parámetro | Tipo | Obligatorio | Ejemplo | Descripción |
Action | String | Sí | DescribeDisks | La operación a ejecutar. Establezca el valor en DescribeDisks. |
RegionId | String | Sí | cn-hangzhou | El ID de región del dispositivo de block storage. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente. |
ZoneId | String | No | cn-hangzhou-g | El ID de zona. |
DiskIds | String | No | ["d-bp67acfmxazb4p**", "d-bp67acfmxazb4g", … "d-bp67acfmxazb4d**"] | Los ID de disco. El valor es una matriz JSON que consta de hasta 100 ID de disco. Separe los ID de disco con comas (,). |
InstanceId | String | No | i-bp67acfmxazb4q**** | El ID de la instancia a la que está conectado el disco. |
DiskType | String | No | all | El tipo de disco. Valores válidos:
Valor predeterminado: all. |
Category | String | No | all | La categoría del disco. Valores válidos:
Valor predeterminado: all. |
Status | String | No | All | El estado del disco en la nube. Para obtener más información, consulte Disk states. Valores válidos:
Valor predeterminado: All. |
SnapshotId | String | No | s-bp67acfmxazb4p**** | El ID de la instantánea utilizada para crear el disco en la nube. |
Portable | Boolean | No | false | Indica si el disco es extraíble. Valores válidos:
El atributo
|
DeleteWithInstance | Boolean | No | false | Indica si se libera el disco en la nube cuando se libera su instancia asociada. Valores válidos:
Valor predeterminado: false. |
DeleteAutoSnapshot | Boolean | No | false | Indica si se eliminan las instantáneas automáticas del disco en la nube cuando este se libera.
Valor predeterminado: false. |
PageNumber | Integer | No | 1 | El número de página. Las páginas comienzan desde la página 1. Valor predeterminado: 1. |
PageSize | Integer | No | 10 | El número de entradas por página. Valor máximo: 100. Valor predeterminado: 10. |
NextToken | String | No | AAAAAdDWBF2**** | El token de paginación que se usa en la siguiente solicitud para recuperar una nueva página de resultados. Debe especificar el token obtenido en la consulta anterior como valor de Para obtener información sobre cómo revisar las respuestas devueltas por esta operación, consulte la sección "Notas de uso" en este tema. |
MaxResults | Integer | No | 50 | El número de entradas por página. Valores válidos: de 10 a 500. Tenga en cuenta lo siguiente:
|
DiskName | String | No | testDiskName | El nombre del disco. |
AutoSnapshotPolicyId | String | No | sp-m5e2w2jutw8bv31**** | El ID de la directiva de instantáneas automáticas aplicada al disco en la nube. |
EnableAutoSnapshot | Boolean | No | true | Indica si se habilita la función de directiva de instantáneas automáticas para el disco en la nube. Valores válidos:
Nota De forma predeterminada, la función de directiva de instantáneas automáticas está habilitada para los discos en la nube creados. Solo necesita aplicar una directiva de instantáneas automáticas a un disco en la nube antes de poder utilizarla. |
EnableAutomatedSnapshotPolicy | Boolean | No | false | Indica si se aplica una directiva de instantáneas automáticas al disco en la nube. Valores válidos:
Valor predeterminado: false. |
DiskChargeType | String | No | PostPaid | El método de facturación del disco. Valores válidos:
|
LockReason | String | No | recycling | El motivo por el cual el disco está bloqueado. Valores válidos:
|
Filter.1.Key | String | No | CreationStartTime | La clave del filtro 1 que se utiliza para consultar recursos. Establezca el valor en |
Filter.2.Key | String | No | CreationEndTime | La clave del filtro 2 que se utiliza para consultar recursos. Establezca el valor en |
Filter.1.Value | String | No | 2017-12-05T22:40Z | El valor del filtro 1 que se utiliza para consultar recursos. Si configura este parámetro, también debe configurar el parámetro |
Filter.2.Value | String | No | 2017-12-06T22:40Z | El valor del filtro 2 que se utiliza para consultar recursos. Si configura este parámetro, también debe configurar el parámetro |
ResourceGroupId | String | No | rg-bp67acfmxazb4p**** | El ID del resource group al que pertenece el disco. Si utiliza este parámetro para filtrar recursos, el número de recursos en un resource group específico no puede exceder los 1,000. Nota No se pueden filtrar los recursos del resource group predeterminado. |
EnableShared | Boolean | No | false | Indica si el disco es un dispositivo de Shared Block Storage. |
Encrypted | Boolean | No | false | Indica si se consultan solo discos en la nube cifrados. Valores válidos:
Valor predeterminado: false. |
DryRun | Boolean | No | false | Indica si se realiza solo una prueba sin ejecutar la solicitud real. Valores válidos:
Valor predeterminado: false. |
KMSKeyId | String | No | 0e478b7a-4262-4802-b8cb-00d3fb40**** | El ID de la clave de Key Management Service (KMS) utilizada por el disco en la nube. |
MultiAttach | String | No | Disabled | Indica si la función de montaje múltiple está habilitada. Valores válidos:
La función de montaje múltiple se encuentra en vista previa por invitación. Para utilizar esta función, submit a ticket. |
Tag.N.key | String | No | null | La clave de la etiqueta N del disco. Nota Se recomienda utilizar el otro parámetro Tag.N.Key para garantizar la compatibilidad. |
Tag.N.Key | String | No | TestKey | La clave de la etiqueta N del disco. Valores válidos de N: de 1 a 20. Si se especifica una sola etiqueta para consultar recursos, se devuelven hasta 1,000 recursos que tienen esta etiqueta agregada. Si se especifican varias etiquetas para consultar recursos, se devuelven hasta 1,000 recursos que tienen todas estas etiquetas agregadas. Para consultar más de 1,000 recursos con las etiquetas especificadas, llame a la operación ListTagResources. |
Tag.N.Value | String | No | TestValue | El valor de la etiqueta N del disco. Valores válidos de N: de 1 a 20. |
Tag.N.value | String | No | null | El valor de la etiqueta N del disco. Nota Se recomienda utilizar el otro parámetro Tag.N.Value para garantizar la compatibilidad. |
AdditionalAttributes.N | String | No | IOPS | El valor del atributo N. Establezca el valor en IOPS, que indica el máximo de operaciones de entrada/salida por segundo (IOPS) del disco. |
Parámetros de respuesta
Parámetro | Tipo | Ejemplo | Descripción |
NextToken | String | AAAAAdDWBF2**** | El token de consulta devuelto en esta llamada. |
PageSize | Integer | 1 | El número de entradas por página. |
PageNumber | Integer | 1 | El número de página. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | El ID de la solicitud. |
TotalCount | Integer | 15 | El número total de entradas devueltas. |
Disks | Array of Disk | Detalles sobre los discos. | |
Disk | |||
SerialNumber | String | bp18um4r4f2fve2**** | El número de serie del disco. |
CreationTime | String | 2021-06-07T06:08:54Z | La hora en que se creó el disco. |
Status | String | In_use | El estado del disco en la nube. Valores válidos:
|
Type | String | system | El tipo de disco. Valores válidos:
|
PerformanceLevel | String | PL0 | El nivel de rendimiento del ESSD. Valores válidos:
|
BdfId | String | null | Este parámetro se encuentra en vista previa por invitación y no está disponible públicamente. |
EnableAutoSnapshot | Boolean | false | Indica si la función de directiva de instantáneas automáticas está habilitada para el disco en la nube. |
StorageSetId | String | ss-i-bp1j4i2jdf3owlhe**** | El ID del conjunto de almacenamiento. |
StorageSetPartitionNumber | Integer | 11 | El número máximo de particiones en el conjunto de almacenamiento. |
DiskId | String | d-bp18um4r4f2fve24**** | El ID del disco. |
DeleteAutoSnapshot | Boolean | false | Indica si se eliminan las instantáneas automáticas del disco en la nube cuando este se libera. Valores válidos:
Las instantáneas creadas en la consola de ECS o al llamar a la operación CreateSnapshot se conservan y no se ven afectadas por este parámetro. |
StorageClusterId | String | dbsc-j5e1sf2vaf5he8m2**** | El ID del clúster de block storage dedicado al que pertenece el disco en la nube. Si su disco en la nube pertenece al clúster de block storage público, se devuelve un valor vacío. |
Encrypted | Boolean | false | Indica si el disco en la nube está cifrado. |
IOPSRead | Integer | 2000 | El número máximo de operaciones de lectura de E/S por segundo. |
MountInstanceNum | Integer | 1 | El número de instancias a las que está conectado el dispositivo de Shared Block Storage. |
Description | String | testDescription | La descripción del disco. |
Device | String | /dev/xvdb | El nombre del dispositivo del disco en su instancia asociada. Ejemplo: /dev/xvdb. Tenga en cuenta lo siguiente:
Nota Este parámetro quedará obsoleto. Se recomienda utilizar otros parámetros para garantizar la compatibilidad. |
DiskName | String | testDiskName | El nombre del disco. |
Portable | Boolean | false | Indica si el disco es extraíble. |
ImageId | String | m-bp13aqm171qynt3u*** | El ID de la imagen utilizada para crear la instancia. Este parámetro está vacío a menos que el disco en la nube se haya creado a partir de una imagen. El valor de este parámetro permanece sin cambios durante todo el ciclo de vida del disco en la nube. |
KMSKeyId | String | 0e478b7a-4262-4802-b8cb-00d3fb408*** | El ID de la clave de KMS utilizada por el disco en la nube. |
DeleteWithInstance | Boolean | true | Indica si el disco en la nube se libera cuando se libera su instancia asociada. Valores válidos:
|
DetachedTime | String | 2021-06-07T21:01:22Z | La hora en que se desconectó el disco en la nube por última vez. |
SourceSnapshotId | String | s-bp67acfmxazb4p**** | El ID de la instantánea utilizada para crear el disco en la nube. Este parámetro se deja vacío a menos que el disco en la nube se haya creado a partir de una instantánea. El valor de este parámetro permanece sin cambios durante todo el ciclo de vida del disco en la nube. |
AutoSnapshotPolicyId | String | sp-bp67acfmxazb4p**** | El ID de la directiva de instantáneas automáticas aplicada al disco en la nube. |
EnableAutomatedSnapshotPolicy | Boolean | false | Indica si se aplica una directiva de instantáneas automáticas al disco en la nube. |
IOPSWrite | Integer | 2000 | El número máximo de operaciones de escritura por segundo. |
InstanceId | String | i-bp67acfmxazb4q**** | El ID de la instancia a la que está conectado el disco. Tenga en cuenta lo siguiente:
|
IOPS | Integer | 4000 | El número máximo de IOPS. |
RegionId | String | cn-hangzhou | El ID de región del disco. |
ExpiredTime | String | 2021-07-07T16:00Z | La hora en que vence el disco en la nube de suscripción. |
Size | Integer | 60 | El tamaño del disco. Unidad: GiB. |
ResourceGroupId | String | rg-bp67acfmxazb4p**** | El ID del resource group al que pertenece el disco. |
DiskChargeType | String | PrePaid | El método de facturación del disco. Valores válidos:
|
ZoneId | String | cn-hangzhou-i | El ID de zona del disco. |
AttachedTime | String | 2021-06-07T06:08:56Z | La hora en que se conectó el disco en la nube por última vez. La hora sigue el estándar ISO 8601 en el formato yyyy-MM-ddThh:mmZ. La hora se muestra en UTC. |
Category | String | cloud_ssd | La categoría del disco. Valores válidos:
|
ProductCode | String | jxsc000204 | El código de producto en Alibaba Cloud Marketplace. |
MultiAttach | String | Disabled | Indica si la función de montaje múltiple está habilitada para el disco en la nube. |
OperationLocks | Array of OperationLock | Los motivos por los cuales el disco está bloqueado. | |
OperationLock | |||
LockReason | String | security | El motivo de seguridad por el cual el disco está bloqueado. |
MountInstances | Array of MountInstance | La información de conexión del dispositivo de Shared Block Storage. | |
MountInstance | |||
AttachedTime | String | 2017-12-05T2340:00Z | La hora de conexión. La hora sigue el estándar ISO 8601 en el formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC. |
InstanceId | String | i-bp1j4i2jdf3owlhe**** | El ID de la instancia a la que está conectado el disco. |
Device | String | /dev/xvda | El punto de montaje del disco. |
Tags | Array of Tag | Las etiquetas del disco. | |
Tag | |||
TagValue | String | TestValue | El valor de la etiqueta del disco. |
TagKey | String | TestKey | La clave de la etiqueta del disco. |
Attachments | Array of Attachment | La información de conexión del disco en la nube. El valor es una matriz que consta de los valores de | |
Attachment | |||
InstanceId | String | i-bp67acfmxazb4q**** | El ID de la instancia a la que está conectado el disco. |
Device | String | /dev/xvda | El nombre del dispositivo del disco. |
AttachedTime | String | 2021-06-07T06:08:56Z | La hora de conexión. La hora se muestra en UTC. |
ProvisionedIops | Long | 40000 | Las IOPS de lectura/escritura aprovisionadas del disco ESSD AutoPL. Valores válidos: de 0 a min{50,000, 1,000 × Capacidad - IOPS base}. Rendimiento base = min{1,800 + 50 × Capacidad, 50,000} Este parámetro solo es compatible si el parámetro |
BurstingEnabled | Boolean | false | Indica si la función de ráfaga de rendimiento está habilitada. Valores válidos:
Este parámetro solo es compatible si el parámetro |
Throughput | Integer | 100 | La cantidad de datos transferidos por segundo. Unidad: MB/s. |
ThroughputRead | Integer | 100 | La cantidad de datos que lee el sistema por segundo. Unidad: MB/s. |
ThroughputWrite | Integer | 100 | La cantidad de datos que escribe el sistema por segundo. Unidad: MB/s. |
Ejemplos
Solicitudes de ejemplo
https://ecs.aliyuncs.com/?Action=DescribeDisks
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&<Common request parameters>
Respuestas exitosas de ejemplo
XML formato
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDisksResponse>
<TotalCount>15</TotalCount>
<NextToken>AAAAAdDWBF2****</NextToken>
<PageSize>1</PageSize>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<PageNumber>1</PageNumber>
<Disks>
<Disk>
<DetachedTime/>
<Category>cloud_ssd</Category>
<Description>testDescription</Description>
<KMSKeyId/>
<ResourceGroupId/>
<DedicatedBlockStorageClusterId/>
<Encrypted>false</Encrypted>
<Size>40</Size>
<DeleteAutoSnapshot>false</DeleteAutoSnapshot>
<DiskChargeType>PrePaid</DiskChargeType>
<MultiAttach>Disabled</MultiAttach>
<Attachments>
<Attachment>
<AttachedTime>2021-06-07T06:08:56Z</AttachedTime>
<InstanceId>i-bp67acfmxazb4q****</InstanceId>
<Device>/dev/xvda</Device>
</Attachment>
</Attachments>
<ExpiredTime>2021-07-07T16:00Z</ExpiredTime>
<ImageId>m-bp13aqm171qynt3u***</ImageId>
<StorageSetId/>
<Tags>
</Tags>
<Status>In_use</Status>
<AttachedTime>2021-06-07T06:08:56Z</AttachedTime>
<StorageClusterId>dbsc-j5e1sf2vaf5he8m2****</StorageClusterId>
<ZoneId>cn-hangzhou-i</ZoneId>
<InstanceId>i-bp67acfmxazb4q****</InstanceId>
<SourceSnapshotId/>
<ProductCode/>
<PerformanceLevel>PL0</PerformanceLevel>
<Device>/dev/xvdb</Device>
<DeleteWithInstance>true</DeleteWithInstance>
<EnableAutomatedSnapshotPolicy>false</EnableAutomatedSnapshotPolicy>
<EnableAutoSnapshot>false</EnableAutoSnapshot>
<AutoSnapshotPolicyId>sp-bp67acfmxazb4p****</AutoSnapshotPolicyId>
<DiskName>testDiskName</DiskName>
<OperationLocks>
</OperationLocks>
<BdfId/>
<Portable>false</Portable>
<Type>system</Type>
<SerialNumber>bp18um4r4f2fve2****</SerialNumber>
<CreationTime>2021-06-07T06:08:54Z</CreationTime>
<RegionId>cn-hangzhou</RegionId>
<DiskId>d-bp18um4r4f2fve24****</DiskId>
</Disk>
</Disks>
</DescribeDisksResponse>
JSON formato
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 15,
"NextToken" : "AAAAAdDWBF2****",
"PageSize" : 1,
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber" : 1,
"Disks" : {
"Disk" : [ {
"DetachedTime" : "",
"Category" : "cloud_ssd",
"Description" : "testDescription",
"KMSKeyId" : "",
"ResourceGroupId" : "",
"DedicatedBlockStorageClusterId" : "",
"Encrypted" : false,
"Size" : 40,
"DeleteAutoSnapshot" : false,
"DiskChargeType" : "PrePaid",
"MultiAttach" : "Disabled",
"Attachments" : {
"Attachment" : [ {
"AttachedTime" : "2021-06-07T06:08:56Z",
"InstanceId" : "i-bp67acfmxazb4q****",
"Device" : "/dev/xvda"
} ]
},
"ExpiredTime" : "2021-07-07T16:00Z",
"ImageId" : "m-bp13aqm171qynt3u***",
"StorageSetId" : "",
"Tags" : {
"Tag" : [ ]
},
"Status" : "In_use",
"AttachedTime" : "2021-06-07T06:08:56Z",
"StorageClusterId" : "dbsc-j5e1sf2vaf5he8m2****",
"ZoneId" : "cn-hangzhou-i",
"InstanceId" : "i-bp67acfmxazb4q****",
"SourceSnapshotId" : "",
"ProductCode" : "",
"PerformanceLevel" : "PL0",
"Device" : "/dev/xvdb",
"DeleteWithInstance" : true,
"EnableAutomatedSnapshotPolicy" : false,
"EnableAutoSnapshot" : false,
"AutoSnapshotPolicyId" : "sp-bp67acfmxazb4p****",
"DiskName" : "testDiskName",
"OperationLocks" : {
"OperationLock" : [ ]
},
"BdfId" : "",
"Portable" : false,
"Type" : "system",
"SerialNumber" : "bp18um4r4f2fve2****",
"CreationTime" : "2021-06-07T06:08:54Z",
"RegionId" : "cn-hangzhou",
"DiskId" : "d-bp18um4r4f2fve24****"
} ]
}
}
Códigos de error
|
Código de estado HTTP |
Código de error |
Mensaje de error |
Descripción |
|
400 |
InvalidDiskType.ValueNotSupported |
The specified disk type is not supported. |
Tipo de disco no válido. |
|
400 |
InvalidCategory.ValueNotSupported |
The specified disk category is not supported. |
Categoría de disco no válida. |
|
400 |
InvalidStatus.ValueNotSupported |
The specified disk status is not supported. |
Esta operación no se puede realizar en el disco en su estado actual. |
|
400 |
InvalidTag.Mismatch |
The specified Tag.n.Key and Tag.n.Value are not match. |
Los parámetros Tag.N.Key y Tag.N.Value especificados no se corresponden entre sí. |
|
400 |
InvalidTagCount |
The specified tags are beyond the permitted range. |
Se ha excedido el número máximo de etiquetas. |
|
400 |
InvalidRegion.NotFound |
The specified parameter RegionId is not valid. |
Valor de RegionId no válido. |
|
400 |
InvalidZoneId.NotFound |
The zoneId provided does not exist in our records. |
No se encontró el ID de zona especificado. |
|
400 |
MissingParamter.RegionId |
The regionId should not be null. |
RegionId es obligatorio. |
|
400 |
InvalidParameter.DiskIds |
The specified parameter diskIds is not valid. |
Valor de DiskIds no válido. |
|
400 |
IncompleteParamter |
Some fields can not be null in this request. |
No se especificó un parámetro obligatorio. |
|
400 |
InvalidParamter |
Some parameters are invalid in this request. |
La solicitud contiene parámetros no válidos. |
|
400 |
InvalidSnapshot.NotFound |
The specified parameter SnapshotId is not valid. |
Valor de SnapshotId no válido. |
|
403 |
InvalidDiskIds.Malformed |
The amount of specified disk Ids exceeds the limit. |
Valor de DiskIds no válido. |
|
403 |
UserNotInTheWhiteList |
The user is not in volume white list. |
No tiene autorización para gestionar el dispositivo de Shared Block Storage. Envíe un ticket para solicitar los permisos. |
|
403 |
InvalidParameter.MultiAttachAndEnableSharedNotMatch |
The parameter MultiAttach and EnableShared are not match. |
Los parámetros MultiAttach y EnableShared especificados no coinciden. |
|
403 |
InvalidParameter.MultiAttach |
The specified param MultiAttach is not valid. |
Valor de MultiAttach no válido. |
|
404 |
InvalidDiskChargeType.NotFound |
The DiskChargeType does not exist in our records |
No se encontró DiskChargeType. |
|
404 |
InvalidLockReason.NotFound |
The specified LockReason is not found |
No se encontró LockReason. |
|
500 |
InternalError |
The request processing has failed due to some unknown error. |
Ocurrió un error interno. Inténtelo de nuevo más tarde. |
Para obtener una lista de códigos de error, consulte Códigos de error del servicio.