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

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

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 aplicação simples correspondentes às imagens personalizadas. Você pode chamar a operação ListRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O valor de ClientToken pode conter 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 do servidor de aplicação simples. O valor pode ser uma matriz JSON que consiste em até 100 IDs de imagens. Separe vários IDs de imagens com vírgulas (,).	["fe9c66133a9d4688872869726b52**", "794c230fd3e64ea19f83f4d7a0ad**"]
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
ImageNames	string	Não	Os nomes das imagens dos servidores de aplicação simples. O valor pode ser uma matriz JSON que consiste em até 100 nomes de imagens. Separe vários nomes de imagens com vírgulas (,).	["test1**", "test2**"]
SystemSnapshotId	string	Não	O ID do snapshot do disco do sistema.	s-bp14m09pq8***0g6
DataSnapshotId	string	Não	O ID do snapshot do disco de dados.	s-acscasca****
Tag	array<object>	Não	A tag N da imagem personalizada.
	object	Não	As tags da imagem personalizada.
Key	string	Não	A chave da tag N. Uma chave de tag pode ter de 1 a 64 caracteres de comprimento. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag N. Um valor de tag pode ter até 64 caracteres de comprimento. 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: não consulta imagens compartilhadas. As imagens compartilhadas não são incluídas na resposta. True: consulta imagens compartilhadas. As imagens compartilhadas são incluídas na resposta. Se você não especificar este parâmetro, todas as imagens serão retornadas.	False
InstanceId	string	Não	O ID do servidor de aplicação simples do qual a imagem é derivada.	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>	A matriz de imagens personalizadas consultadas.
	array<object>	As informações sobre o objeto da matriz.
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 está em UTC.	2022-10-09T02:28:06Z
DataSnapshotName	string	O nome do snapshot do disco de dados.	Data disk snapshot
SystemSnapshotId	string	O ID do snapshot do disco do sistema.	s-bp1h173hj21puxb***
InShare	boolean	Indica se a imagem personalizada é compartilhada com o Elastic Compute Service (ECS).	false
InShareUser	boolean	Indica se a imagem personalizada é compartilhada entre contas.	False
InstanceId	string	O ID do servidor de aplicação simples do qual a imagem é derivada.	2d06ee0520b44de1ae88d4be****
DataSnapshotId	string	O ID do snapshot do disco de dados.	s-bp19rn9u8eqzlfb***
RegionId	string	O ID da região.	cn-hangzhou
SystemSnapshotName	string	O nome do snapshot do disco do sistema.	System disk snapshot
Description	string	A descrição da imagem personalizada.	Custom image-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: disponível 2: indisponível 3: falha na criação 4: criando	1
Tags	array<object>	As tags da imagem personalizada.
	object	As tags da imagem personalizada.
Key	string	The tag key of the custom image.	TestKey
Value	string	The tag value of the custom image.	TestValue
InstanceName	string	O nome do servidor de aplicação simples.	swas-asdf23***
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfm2h2lvp3ublq
CreateInstances	array	Os servidores de aplicação simples criados a partir da imagem.
	string	O ID do servidor de aplicação simples criado a partir da imagem.	9ffb716db6ae406ca78a476c0c81****
UserId	integer	O ID da conta Alibaba Cloud à qual a imagem pertence.	180185828710****
OsType	string	O tipo de sistema operacional da imagem.	Linux
RequiredSystemDiskSize	integer	O tamanho do disco do sistema da imagem. Unidade: GiB.	20
RequiredDataDiskSize	integer	O tamanho do disco de dados da imagem. Unidade: GiB.	20
SourceImageName	string	O nome da imagem de origem usada para criar o servidor de aplicação simples.	CentOS
SourceImageVersion	string	A versão da imagem de origem usada para criar o servidor de aplicação simples.	8.0
TotalCount	string	O número total de entradas retornadas.	4
PageSize	string	O número de entradas por página.	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": "Data disk snapshot",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InShareUser": true,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "System disk snapshot",
      "Description": "Custom image-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.