Consulta dispositivos de armazenamento em bloco criados por você, incluindo discos de nuvem e discos locais.
Observações de uso
Configure vários parâmetros de solicitação como filtros, como RegionId, ZoneId, DiskIds e InstanceId. O sistema avalia os parâmetros configurados com o operador "AND". Se você especificar mais de um filtro, a API retornará apenas os registros correspondentes a todos eles.
O valor do parâmetro DiskIds é uma matriz JSON. Caso não configure o parâmetro DiskIds, ele não funcionará como filtro. Se definido como uma matriz JSON vazia, será considerado um filtro válido e a API retornará um resultado vazio.
-
Utilize um dos métodos abaixo para verificar as respostas:
Método 1: Use NextToken para definir o token de consulta. Defina o valor como o NextToken retornado na última chamada à operação DescribeDisks. Em seguida, use MaxResults para especificar o número máximo de entradas por página.
-
Método 2: Configure o parâmetro PageSize para definir o número de entradas por página e o parâmetro PageNumber para indicar a página desejada.
Use apenas um dos métodos acima. Para grandes volumes de dados, recomenda-se o Método 1. Quando o parâmetro NextToken estiver configurado, os parâmetros PageSize e PageNumber não terão efeito e o parâmetro TotalCount na resposta será inválido.
Um disco de nuvem com o recurso de anexação múltipla ativado pode ser anexado a várias instâncias. Consulte os valores de Attachment na resposta para obter informações sobre a anexação do disco.
Ao chamar uma operação de API usando o Alibaba Cloud CLI, especifique os valores dos parâmetros de solicitação nos formatos exigidos para cada tipo de dado. Para mais detalhes, consulte Visão geral do formato de parâmetros.
Depuração
Parâmetros de solicitação
Parâmetro | Tipo | Obrigatório | Exemplo | Descrição |
Action | String | Sim | DescribeDisks | A operação a ser executada. Defina o valor como DescribeDisks. |
RegionId | String | Sim | cn-hangzhou | O ID da região do dispositivo de armazenamento em bloco. Chame a operação DescribeRegions para consultar a lista mais recente de regiões. |
ZoneId | String | Não | cn-hangzhou-g | O ID da zona. |
DiskIds | String | Não | ["d-bp67acfmxazb4p**", "d-bp67acfmxazb4g", … "d-bp67acfmxazb4d**"] | Os IDs dos discos. O valor é uma matriz JSON composta por até 100 IDs de disco. Separe os IDs com vírgulas (,). |
InstanceId | String | Não | i-bp67acfmxazb4q**** | O ID da instância à qual o disco está anexado. |
DiskType | String | Não | all | O tipo do disco. Valores válidos:
Valor padrão: all. |
Category | String | Não | all | A categoria do disco. Valores válidos:
Valor padrão: all. |
Status | String | Não | All | O status do disco de nuvem. Para mais informações, consulte Estados do disco. Valores válidos:
Valor padrão: All. |
SnapshotId | String | Não | s-bp67acfmxazb4p**** | O ID do snapshot usado para criar o disco de nuvem. |
Portable | Boolean | Não | false | Indica se o disco é removível. Valores válidos:
O atributo
|
DeleteWithInstance | Boolean | Não | false | Indica se o disco de nuvem deve ser liberado quando a instância associada for liberada. Valores válidos:
Valor padrão: false. |
DeleteAutoSnapshot | Boolean | Não | false | Indica se os snapshots automáticos do disco de nuvem devem ser excluídos quando o disco for liberado.
Valor padrão: false. |
PageNumber | Integer | Não | 1 | O número da página. As páginas começam na página 1. Valor padrão: 1. |
PageSize | Integer | Não | 10 | O número de entradas por página. Valor máximo: 100. Valor padrão: 10. |
NextToken | String | Não | AAAAAdDWBF2**** | O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Especifique o token obtido na consulta anterior como valor de Para saber como verificar as respostas retornadas por esta operação, consulte a seção "Observações de uso" neste tópico. |
MaxResults | Integer | Não | 50 | O número de entradas por página. Valores válidos: 10 a 500. Observe os seguintes itens:
|
DiskName | String | Não | testDiskName | O nome do disco. |
AutoSnapshotPolicyId | String | Não | sp-m5e2w2jutw8bv31**** | O ID da política de snapshot automático aplicada ao disco de nuvem. |
EnableAutoSnapshot | Boolean | Não | true | Indica se o recurso de política de snapshot automático está ativado para o disco de nuvem. Valores válidos:
Nota Por padrão, o recurso de política de snapshot automático vem ativado nos discos de nuvem criados. Basta aplicar uma política de snapshot automático a um disco para começar a usá-la. |
EnableAutomatedSnapshotPolicy | Boolean | Não | false | Indica se uma política de snapshot automático está aplicada ao disco de nuvem. Valores válidos:
Valor padrão: false. |
DiskChargeType | String | Não | PostPaid | O método de faturamento do disco. Valores válidos:
|
LockReason | String | Não | recycling | O motivo pelo qual o disco está bloqueado. Valores válidos:
|
Filter.1.Key | String | Não | CreationStartTime | A chave do filtro 1 usada para consultar recursos. Defina o valor como |
Filter.2.Key | String | Não | CreationEndTime | A chave do filtro 2 usada para consultar recursos. Defina o valor como |
Filter.1.Value | String | Não | 2017-12-05T22:40Z | O valor do filtro 1 usado para consultar recursos. Ao configurar este parâmetro, também configure o parâmetro |
Filter.2.Value | String | Não | 2017-12-06T22:40Z | O valor do filtro 2 usado para consultar recursos. Ao configurar este parâmetro, também configure o parâmetro |
ResourceGroupId | String | Não | rg-bp67acfmxazb4p**** | O ID do grupo de recursos ao qual o disco pertence. Ao usar este parâmetro para filtrar recursos, o número de recursos em um grupo específico não pode exceder 1.000. Nota Não é possível filtrar recursos no grupo de recursos padrão. |
EnableShared | Boolean | Não | false | Indica se o disco é um dispositivo de Shared Block Storage. |
Encrypted | Boolean | Não | false | Indica se a consulta deve retornar apenas discos de nuvem criptografados. Valores válidos:
Valor padrão: false. |
DryRun | Boolean | Não | false | Indica se deve ser executada apenas uma simulação, sem realizar a solicitação real. Valores válidos:
Valor padrão: false. |
KMSKeyId | String | Não | 0e478b7a-4262-4802-b8cb-00d3fb40**** | O ID da chave do Key Management Service (KMS) usada pelo disco de nuvem. |
MultiAttach | String | Não | Disabled | Indica se o recurso de anexação múltipla está ativado. Valores válidos:
O recurso de anexação múltipla está em visualização por convite. Para usar este recurso, abra um ticket. |
Tag.N.key | String | Não | null | A chave da tag N do disco. Nota Recomendamos usar o outro parâmetro Tag.N.Key para garantir compatibilidade. |
Tag.N.Key | String | Não | TestKey | A chave da tag N do disco. Valores válidos de N: 1 a 20. Se uma única tag for especificada para consultar recursos, até 1.000 recursos com essa tag serão retornados. Se várias tags forem especificadas, até 1.000 recursos contendo todas essas tags serão retornados. Para consultar mais de 1.000 recursos com as tags especificadas, chame a operação ListTagResources. |
Tag.N.Value | String | Não | TestValue | O valor da tag N do disco. Valores válidos de N: 1 a 20. |
Tag.N.value | String | Não | null | O valor da tag N do disco. Nota Recomendamos usar o outro parâmetro Tag.N.Value para garantir compatibilidade. |
AdditionalAttributes.N | String | Não | IOPS | O valor do atributo N. Defina o valor como IOPS, que indica o número máximo de operações de entrada/saída por segundo (IOPS) do disco. |
Parâmetros de resposta
Parâmetro | Tipo | Exemplo | Descrição |
NextToken | String | AAAAAdDWBF2**** | O token de consulta retornado nesta chamada. |
PageSize | Integer | 1 | O número de entradas por página. |
PageNumber | Integer | 1 | O número da página. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | O ID da solicitação. |
TotalCount | Integer | 15 | O número total de entradas retornadas. |
Disks | Array of Disk | Detalhes sobre os discos. | |
Disk | |||
SerialNumber | String | bp18um4r4f2fve2**** | O número de série do disco. |
CreationTime | String | 2021-06-07T06:08:54Z | O horário de criação do disco. |
Status | String | In_use | O status do disco de nuvem. Valores válidos:
|
Type | String | system | O tipo do disco. Valores válidos:
|
PerformanceLevel | String | PL0 | O nível de desempenho do ESSD. Valores válidos:
|
BdfId | String | null | Este parâmetro está em visualização por convite e não está disponível publicamente. |
EnableAutoSnapshot | Boolean | false | Indica se o recurso de política de snapshot automático está ativado para o disco de nuvem. |
StorageSetId | String | ss-i-bp1j4i2jdf3owlhe**** | O ID do conjunto de armazenamento. |
StorageSetPartitionNumber | Integer | 11 | O número máximo de partições no conjunto de armazenamento. |
DiskId | String | d-bp18um4r4f2fve24**** | O ID do disco. |
DeleteAutoSnapshot | Boolean | false | Indica se os snapshots automáticos do disco de nuvem são excluídos quando o disco é liberado. Valores válidos:
Snapshots criados no console ECS ou pela chamada da operação CreateSnapshot são retidos e não são afetados por este parâmetro. |
StorageClusterId | String | dbsc-j5e1sf2vaf5he8m2**** | O ID do cluster de armazenamento em bloco dedicado ao qual o disco de nuvem pertence. Se o disco pertencer ao cluster de armazenamento em bloco público, um valor vazio será retornado. |
Encrypted | Boolean | false | Indica se o disco de nuvem está criptografado. |
IOPSRead | Integer | 2000 | O número máximo de operações de leitura de I/O por segundo. |
MountInstanceNum | Integer | 1 | O número de instâncias às quais o dispositivo de Shared Block Storage está anexado. |
Description | String | testDescription | A descrição do disco. |
Device | String | /dev/xvdb | O nome do dispositivo do disco em sua instância associada. Exemplo: /dev/xvdb. Observe os seguintes itens:
Nota Este parâmetro será descontinuado. Recomendamos usar outros parâmetros para garantir compatibilidade. |
DiskName | String | testDiskName | O nome do disco. |
Portable | Boolean | false | Indica se o disco é removível. |
ImageId | String | m-bp13aqm171qynt3u*** | O ID da imagem usada para criar a instância. Este parâmetro fica vazio, a menos que o disco de nuvem tenha sido criado a partir de uma imagem. O valor deste parâmetro permanece inalterado durante todo o ciclo de vida do disco. |
KMSKeyId | String | 0e478b7a-4262-4802-b8cb-00d3fb408*** | O ID da chave KMS usada pelo disco de nuvem. |
DeleteWithInstance | Boolean | true | Indica se o disco de nuvem é liberado quando a instância associada é liberada. Valores válidos:
|
DetachedTime | String | 2021-06-07T21:01:22Z | O horário da última desanexação do disco de nuvem. |
SourceSnapshotId | String | s-bp67acfmxazb4p**** | O ID do snapshot usado para criar o disco de nuvem. Este parâmetro fica vazio, a menos que o disco tenha sido criado a partir de um snapshot. O valor permanece inalterado durante todo o ciclo de vida do disco. |
AutoSnapshotPolicyId | String | sp-bp67acfmxazb4p**** | O ID da política de snapshot automático aplicada ao disco de nuvem. |
EnableAutomatedSnapshotPolicy | Boolean | false | Indica se uma política de snapshot automático está aplicada ao disco de nuvem. |
IOPSWrite | Integer | 2000 | O número máximo de operações de gravação por segundo. |
InstanceId | String | i-bp67acfmxazb4q**** | O ID da instância à qual o disco está anexado. Observe os seguintes itens:
|
IOPS | Integer | 4000 | O número máximo de IOPS. |
RegionId | String | cn-hangzhou | O ID da região do disco. |
ExpiredTime | String | 2021-07-07T16:00Z | O horário de expiração do disco de nuvem por assinatura. |
Size | Integer | 60 | O tamanho do disco. Unidade: GiB. |
ResourceGroupId | String | rg-bp67acfmxazb4p**** | O ID do grupo de recursos ao qual o disco pertence. |
DiskChargeType | String | PrePaid | O método de faturamento do disco. Valores válidos:
|
ZoneId | String | cn-hangzhou-i | O ID da zona do disco. |
AttachedTime | String | 2021-06-07T06:08:56Z | O horário da última anexação do disco de nuvem. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddThh:mmZ e é exibido em UTC. |
Category | String | cloud_ssd | A categoria do disco. Valores válidos:
|
ProductCode | String | jxsc000204 | O código do produto no Alibaba Cloud Marketplace. |
MultiAttach | String | Disabled | Indica se o recurso de anexação múltipla está ativado para o disco de nuvem. |
OperationLocks | Array of OperationLock | Os motivos pelos quais o disco está bloqueado. | |
OperationLock | |||
LockReason | String | security | O motivo de segurança pelo qual o disco está bloqueado. |
MountInstances | Array of MountInstance | As informações de anexação do dispositivo de Shared Block Storage. | |
MountInstance | |||
AttachedTime | String | 2017-12-05T2340:00Z | O horário da anexação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. |
InstanceId | String | i-bp1j4i2jdf3owlhe**** | O ID da instância à qual o disco está anexado. |
Device | String | /dev/xvda | O ponto de montagem do disco. |
Tags | Array of Tag | As tags do disco. | |
Tag | |||
TagValue | String | TestValue | O valor da tag do disco. |
TagKey | String | TestKey | A chave da tag do disco. |
Attachments | Array of Attachment | As informações de anexação do disco de nuvem. O valor é uma matriz composta pelos valores de | |
Attachment | |||
InstanceId | String | i-bp67acfmxazb4q**** | O ID da instância à qual o disco está anexado. |
Device | String | /dev/xvda | O nome do dispositivo do disco. |
AttachedTime | String | 2021-06-07T06:08:56Z | O horário da anexação. O horário é exibido em UTC. |
ProvisionedIops | Long | 40000 | O IOPS de leitura/gravação provisionado do disco ESSD AutoPL. Valores válidos: 0 a min{50.000, 1.000 × Capacidade - IOPS Base}. Desempenho base = min{1.800 + 50 × Capacidade, 50.000} Este parâmetro é suportado apenas se o parâmetro |
BurstingEnabled | Boolean | false | Indica se o recurso de pico de desempenho está ativado. Valores válidos:
Este parâmetro é suportado apenas se o parâmetro |
Throughput | Integer | 100 | A quantidade de dados transferidos por segundo. Unidade: MB/s. |
ThroughputRead | Integer | 100 | A quantidade de dados lidos pelo sistema por segundo. Unidade: MB/s. |
ThroughputWrite | Integer | 100 | A quantidade de dados gravados pelo sistema por segundo. Unidade: MB/s. |
Exemplos
Exemplos de solicitações
https://ecs.aliyuncs.com/?Action=DescribeDisks
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&<Common request parameters>
Exemplos de respostas de sucesso
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 erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|
400 |
InvalidDiskType.ValueNotSupported |
The specified disk type is not supported. |
Tipo de disco inválido. |
|
400 |
InvalidCategory.ValueNotSupported |
The specified disk category is not supported. |
Categoria de disco inválida. |
|
400 |
InvalidStatus.ValueNotSupported |
The specified disk status is not supported. |
Esta operação não pode ser executada no estado atual do disco. |
|
400 |
InvalidTag.Mismatch |
The specified Tag.n.Key and Tag.n.Value are not match. |
Os parâmetros Tag.N.Key e Tag.N.Value especificados não correspondem entre si. |
|
400 |
InvalidTagCount |
The specified tags are beyond the permitted range. |
O número máximo de tags foi excedido. |
|
400 |
InvalidRegion.NotFound |
The specified parameter RegionId is not valid. |
Valor de RegionId inválido. |
|
400 |
InvalidZoneId.NotFound |
The zoneId provided does not exist in our records. |
O ID da zona especificado não foi encontrado. |
|
400 |
MissingParamter.RegionId |
The regionId should not be null. |
RegionId é obrigatório. |
|
400 |
InvalidParameter.DiskIds |
The specified parameter diskIds is not valid. |
Valor de DiskIds inválido. |
|
400 |
IncompleteParamter |
Some fields can not be null in this request. |
Um parâmetro obrigatório não foi especificado. |
|
400 |
InvalidParamter |
Some parameters are invalid in this request. |
A solicitação contém parâmetros inválidos. |
|
400 |
InvalidSnapshot.NotFound |
The specified parameter SnapshotId is not valid. |
Valor de SnapshotId inválido. |
|
403 |
InvalidDiskIds.Malformed |
The amount of specified disk Ids exceeds the limit. |
Valor de DiskIds inválido. |
|
403 |
UserNotInTheWhiteList |
The user is not in volume white list. |
Você não tem autorização para gerenciar o dispositivo de Shared Block Storage. Abra um ticket para solicitar as permissões. |
|
403 |
InvalidParameter.MultiAttachAndEnableSharedNotMatch |
The parameter MultiAttach and EnableShared are not match. |
Os parâmetros MultiAttach e EnableShared especificados não correspondem. |
|
403 |
InvalidParameter.MultiAttach |
The specified param MultiAttach is not valid. |
Valor de MultiAttach inválido. |
|
404 |
InvalidDiskChargeType.NotFound |
The DiskChargeType does not exist in our records |
O DiskChargeType não foi encontrado. |
|
404 |
InvalidLockReason.NotFound |
The specified LockReason is not found |
O LockReason não foi encontrado. |
|
500 |
InternalError |
The request processing has failed due to some unknown error. |
Ocorreu um erro interno. Tente novamente mais tarde. |
Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.