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

Consulta informações sobre uma ou mais imagens personalizadas que foram criadas em uma região especificada.

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:ListCustomImages

get

*CustomImage.

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

*CustomImage.

acs:swas-open:{#regionId}:{#accountId}:customimage/{#CustomImageId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região dos servidores de aplicativos simples. Você pode chamar ListRegions para consultar a lista de regiões suportadas.	cn-hangzhou
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. Um token de cliente é gerado pelo seu cliente e deve ser único entre diferentes solicitações. ClientToken suporta apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento. Para mais informações, consulte Como garantir a idempotência.	123e4567-e89b-12d3-a456-426655440000
ImageIds	string	Não	Os IDs das imagens dos servidores de aplicativos simples. O valor pode ser um array JSON composto por até 100 IDs de instância. Separe vários IDs de instância com vírgulas (,).	["fe9c66133a9d4688872869726b52**", "794c230fd3e64ea19f83f4d7a0ad**"]
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página da lista de snapshots. Valor padrão: 1.	1
ImageNames	string	Não	Os nomes das imagens dos servidores de aplicativos simples. O valor pode ser um array JSON composto por até 100 IDs de instância. Separe vários IDs de instância com vírgulas (,).	["test1**", "test2**"]
SystemSnapshotId	string	Não	O ID do snapshot do disco em nuvem do sistema.	s-bp14m09pq8***0g6
DataSnapshotId	string	Não	O ID do snapshot do disco em nuvem de dados.	s-acscasca****
Tag	array<object>	Não	As tags das imagens personalizadas.
	object	Não	A tag.
Key	string	Não	A chave da tag da imagem personalizada. Valores válidos para o comprimento da chave da tag: 1 a 64. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag da imagem personalizada. Valores válidos para o comprimento do valor da tag: 1 a 64. Valores válidos de N: 1 a 20.	TestValue
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aek2bti7cf7yj2i
Share	boolean	Não	Especifica se devem ser consultadas imagens compartilhadas. Valores válidos: False: A resposta não inclui imagens compartilhadas. True: Apenas imagens compartilhadas são retornadas. Se este parâmetro não for especificado, todas as imagens serão retornadas por padrão.	False
InstanceId	string	Não	O ID da instância do servidor de aplicativos simples a partir da qual a imagem foi criada.	ace0706b2ac4454d984295a94213****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	20758A-585D-4A41-A9B2-28DA8F4F534F
CustomImages	array<object>	As imagens personalizadas.
	array<object>	A imagem personalizada.
CreationTime	string	A hora em que o snapshot foi criado. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-10-09T02:28:06Z
DataSnapshotName	string	O nome do snapshot do disco em nuvem de dados.	DataDiskSnapshot
SystemSnapshotId	string	O ID do snapshot do disco em nuvem do sistema.	s-bp1h173hj21puxb***
InShare	boolean	Indica se a imagem personalizada está compartilhada com o ECS.	false
InShareUser	boolean	Indica se a imagem personalizada está compartilhada entre contas.	False
InstanceId	string	O ID da instância do servidor de aplicativos simples a partir da qual a imagem foi criada.	2d06ee0520b44de1ae88d4be****
DataSnapshotId	string	O ID do snapshot do disco em nuvem de dados.	s-bp19rn9u8eqzlfb***
RegionId	string	O ID da região.	cn-hangzhou
SystemSnapshotName	string	O nome do snapshot do disco em nuvem do sistema.	SystemDiskSnapshot
Description	string	A descrição.	CustomImage-1
Name	string	O nome da imagem personalizada.	test
ImageId	string	O ID da imagem personalizada.	m-bp1e79zktg26n2b***
Status	string	O status da imagem personalizada. Valores válidos: 0: copiando. 1: ativo. 2: indisponível. 3: falha na criação. 4: criando.	1
Tags	array<object>	As tags das imagens personalizadas.
	object	A tag.
Key	string	A chave da tag da imagem personalizada.	TestKey
Value	string	O valor da tag da imagem personalizada.	TestValue
InstanceName	string	O nome da instância do servidor de aplicativos simples.	swas-asdf23***
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfm2h2lvp3ublq
CreateInstances	array	As informações sobre as instâncias criadas a partir da imagem.
	string	O ID da instância criada a partir da imagem.	9ffb716db6ae406ca78a476c0c81****
UserId	integer	O ID da conta Alibaba Cloud do proprietário da imagem.	180185828710****
OsType	string	O tipo de sistema operacional da imagem.	Linux
RequiredSystemDiskSize	integer	O tamanho do disco em nuvem do sistema da imagem. Unidade: GiB.	20
RequiredDataDiskSize	integer	O tamanho do disco em nuvem de dados da imagem. Unidade: GiB.	20
SourceImageName	string	O nome da imagem de origem.	CentOS
SourceImageVersion	string	A versão da imagem de origem.	8.0
TotalCount	string	O número total de entradas.	4
PageSize	string	O número de entradas por página nas Configurações para a consulta paginada.	10
PageNumber	string	O número da página.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "CustomImages": [
    {
      "CreationTime": "2022-10-09T02:28:06Z",
      "DataSnapshotName": "数据盘快照",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InShareUser": true,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "系统盘快照",
      "Description": "自定义镜像-1",
      "Name": "test",
      "ImageId": "m-bp1e79zktg26n2b***",
      "Status": "1",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "swas-asdf23***",
      "ResourceGroupId": "rg-acfm2h2lvp3ublq",
      "CreateInstances": [
        "9ffb716db6ae406ca78a476c0c81****"
      ],
      "UserId": 0,
      "OsType": "Linux",
      "RequiredSystemDiskSize": 20,
      "RequiredDataDiskSize": 20,
      "SourceImageName": "CentOS",
      "SourceImageVersion": "8.0"
    }
  ],
  "TotalCount": "4",
  "PageSize": "10",
  "PageNumber": "1"
}

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.