ListDisks - Simple Application Server: Central de Documentação do Alibaba Cloud

Consulta as informações sobre discos em uma região.

Descrição da operação

Os parâmetros InstanceId, DiskIds e ResourceGroupId são opcionais. No entanto, você pode especificá-los como condições de filtro e combiná-los com o operador lógico AND para filtrar os discos que deseja consultar.

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

swas-open:ListDisks

get

*Disk

acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId}

*Disk

acs:swas-open:{#regionId}:{#accountId}:disk/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região dos discos.	cn-hangzhou
InstanceId	string	Não	O ID do servidor de aplicativo simples.	2ad1ae67295445f598017499dc****
DiskIds	string	Não	Os IDs dos discos. O valor pode ser uma matriz JSON que consiste em até 100 IDs de disco. Separe vários IDs de disco com vírgulas (,).	["d-bp14wq0149cpp2x**", "d-bp14wq0149cpp2y**"]
PageSize	integer	Não	O número de entradas por página. Valor máximo: 100. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
DiskType	string	Não	O tipo de disco. Valores válidos: system: disco do sistema data: disco de dados Por padrão, tanto os discos do sistema quanto os discos de dados são consultados.	system
Tag	array<object>	Não	As tags que são adicionadas aos discos.
	object	Não	As tags do disco.
Key	string	Não	A chave da tag. A chave da tag pode ter até 64 caracteres. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag. O valor da tag pode ter até 64 caracteres. Valores válidos de N: 1 a 20.	TestValue
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aek2bti7cf7****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de entradas retornadas.	1
RequestId	string	O ID da solicitação.	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página.	1
Disks	array<object>	Os discos consultados.
	array<object>	As informações sobre os discos.
CreationTime	string	A hora em que o disco foi criado. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-03-08T05:31:06Z
Status	string	O status do disco. Valores válidos: ReIniting: O disco está sendo inicializado. Creating: O disco está sendo criado. In_use: O disco está em uso. Available: O disco pode ser anexado. Attaching: O disco está sendo anexado. Detaching: O disco está sendo desanexado.	In_use
Device	string	O nome do dispositivo do disco após o disco ser anexado ao servidor de aplicativo simples.	/dev/xvda
Size	integer	O tamanho do disco. Unidade: GB.	50
DiskName	string	O nome do disco.	SystemDisk
DiskChargeType	string	O método de cobrança do disco.	PrePaid
DiskType	string	O tipo de disco. Valores válidos: system: disco do sistema data: disco de dados	System
Category	string	A categoria do disco. Valores válidos: ESSD: SSD aprimorado (ESSD) de PL0 SSD: SSD padrão CLOUD_EFFICIENCY: disco ultra	ESSD
DiskId	string	O ID do disco.	d-bp14wq0149cpp2x****
InstanceId	string	O ID do servidor de aplicativo simples ao qual o disco está anexado.	2ad1ae67295445f598017499dc****
RegionId	string	O ID da região.	cn-hangzhou
Remark	string	As observações do disco.	remark
Tags	array<object>	As tags que são adicionadas aos discos.
	object	As tags do disco.
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
InstanceName	string	O nome do servidor de aplicativo simples.	myInstance
ResourceGroupId	string	O ID do grupo de recursos ao qual o disco pertence.	rg-aek2bti7cf7****

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Disks": [
    {
      "CreationTime": "2021-03-08T05:31:06Z",
      "Status": "In_use",
      "Device": "/dev/xvda",
      "Size": 50,
      "DiskName": "SystemDisk",
      "DiskChargeType": "PrePaid",
      "DiskType": "System",
      "Category": "ESSD",
      "DiskId": "d-bp14wq0149cpp2x****",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "RegionId": "cn-hangzhou",
      "Remark": "remark",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "myInstance",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	An error occurred while processing your request.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.