DescribeDisks - ENS: Central de Documentação do Alibaba Cloud

Consulta informações sobre um ou mais discos criados.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ens:DescribeDisks

get

*Disk.

acs:ens::{#accountId}:disk/{#DiskId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EnsRegionId	string	Não	O ID da zona de borda ENS.	cn-kunming-telecom
DiskId	string	Não	O ID do disco em nuvem.	d-5soak1gqa507lyfzvz0xo****
DiskName	string	Não	O nome do disco.	DiskName
PageNumber	string	Não	O número da página da lista de consulta. Valor mínimo: 1.	1
PageSize	string	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 50.	10
Status	string	Não	O status do disco.	Available
Type	string	Não	A propriedade do disco.	system
Category	string	Não	A categoria do disco.	local_ssd
DiskChargeType	string	Não	O tipo de cobrança.	prepay
EnsRegionIds	string	Não	A lista de zonas de borda.	["cn-suzhou-telecom","cn-chengdu-telecom"]
DiskIds	string	Não	Os IDs dos discos.	[\"d-wz99njena32z90ki****\"]
OrderByParams	string	Não	O parâmetro de ordenação. Exemplo de formato: {"EnsRegionId":"desc"}. Por padrão, os resultados são ordenados pelo ID da zona de borda em ordem decrescente.	{ "DiskNameSort":"desc","EnsRegionIdSort":"asc" }
DiskType	string	Não	O método de aquisição do disco.	PostPayDisk
InstanceId	string	Não	A instância à qual o disco em nuvem está montado.	i-5t77rb0yoz79m28ku60sx****
SnapshotId	string	Não	O ID do snapshot.	s-897654321****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	O código de negócio retornado. Um valor 0 indica sucesso.	0
Disks	object
Disks	array<object>	A lista de informações dos discos.
	array<object>	A lista de informações dos discos.
Category	string	A categoria do disco. Valores válidos: `cloud_efficiency`: Disco em Nuvem de Alta Eficiência `cloud_ssd`: Disco em Nuvem SSD `local_hdd`: HDD local `local_ssd`: SSD local	local_ssd
CreationTime	string	A hora em que o disco foi criado. A hora é exibida em UTC e segue o padrão ISO 8601 no formato `YYYY-MM-DDThh:mm:ssZ`.	2021-11-11T14:34:55+08:00
DiskChargeType	string	O método de cobrança do disco. Valores válidos: prepaid: assinatura postpaid: pay-as-you-go	prepaid
DiskId	string	O ID do disco.	d-5svum1dx1w4a4spr54lgr****
DiskName	string	O nome do disco.	fvt-ecs-5cf0****
EnsRegionId	string	O ID do nó do Edge Node Service (ENS).	cn-guangzhou-10
InstanceId	string	O ID da instância à qual o disco está anexado.	i-5t77rb0yoz79m28ku60sx****
InstanceName	string	O nome da instância à qual o disco está anexado.	边缘prod环境串流机器-1063
Description	string	A descrição do disco.	disk-description
Size	integer	O tamanho do disco. Unidade: MiB.	20
Status	string	O status do disco. Valores válidos: `In-use`: O disco está em uso. `Available`: O disco está disponível para anexação. `Attaching`: O disco está sendo anexado. `Detaching`: O disco está sendo desanexado. `Creating`: O disco está sendo criado. `ReIniting`: O disco está sendo reinicializado.	Available
Type	string	O tipo do disco. Valores válidos: `1`: disco do sistema `2`: disco de dados	1
Portable	boolean	Indica se o disco pode ser desanexado. Valores válidos: `true`: O disco pode existir independentemente e pode ser anexado ou desanexado de uma instância na mesma zona. `false`: O disco não pode existir independentemente. Seu ciclo de vida está vinculado ao da instância. A propriedade Portable é false para os seguintes tipos de disco: HDD local SSD local Disco de dados por assinatura	true
SnapshotId	string	O ID do snapshot a partir do qual o disco foi criado.	s-bp67acfmxazb4p****
SerialId	string	O número de série do disco.	123
Encrypted	boolean	Indica se o disco está criptografado. Valores válidos: true: O disco está criptografado. false: O disco não está criptografado.	false
EncryptedKeyId	string	O ID da chave do Key Management Service (KMS) usada para o disco.	05467897a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	Indica se o disco é liberado quando a instância é liberada. Valores válidos: `true`: O disco é liberado quando a instância é liberada. `false`: O disco não é liberado quando a instância é liberada.	false
Tags	object	As tags do disco.
Tags	array<object>	Uma lista de tags.
	object	Os detalhes de uma tag.
Key	string	A chave da tag.	team
Value	string	O valor da tag.	backend
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas por página para uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	50
RequestId	string	O ID da solicitação.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	O número total de páginas para uma consulta paginada.	13

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 0,
  "Disks": {
    "Disks": [
      {
        "Category": "local_ssd",
        "CreationTime": "2021-11-11T14:34:55+08:00",
        "DiskChargeType": "prepaid",
        "DiskId": "d-5svum1dx1w4a4spr54lgr****",
        "DiskName": "fvt-ecs-5cf0****",
        "EnsRegionId": "cn-guangzhou-10",
        "InstanceId": "i-5t77rb0yoz79m28ku60sx****",
        "InstanceName": "边缘prod环境串流机器-1063",
        "Description": "disk-description",
        "Size": 20,
        "Status": "Available",
        "Type": "1",
        "Portable": true,
        "SnapshotId": "s-bp67acfmxazb4p****",
        "SerialId": "123",
        "Encrypted": false,
        "EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****",
        "DeleteWithInstance": false,
        "Tags": {
          "Tags": [
            {
              "Key": "team",
              "Value": "backend"
            }
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 13
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.