Consulta a lista de recursos de imagem disponíveis para você ao especificar parâmetros como ImageId, cenários de uso da imagem e condições de filtro.
Descrição da operação
Os recursos de imagem que você pode consultar incluem suas imagens personalizadas, imagens públicas fornecidas pela Alibaba Cloud, imagens do Alibaba Cloud Marketplace e imagens compartilhadas que outros usuários da Alibaba Cloud compartilharam com você.
A paginação é suportada. Os resultados da consulta incluem o número total de recursos de imagem disponíveis e os recursos de imagem na página atual. O número padrão de entradas por página é 10.
Ao invocar uma operação de API usando o Cloud Assistant CLI, os parâmetros de solicitação de diferentes tipos de dados devem estar em conformidade com os requisitos de formato. Para obter mais informações, consulte Formato de parâmetro da CLI.
Ao consultar imagens fornecidas pela Alibaba Cloud ou imagens compartilhadas (ImageOwnerAlias definido como system ou others), as regras de autenticação do RAM podem ser ignoradas para esta solicitação. Para obter mais informações, consulte Regras de autenticação.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
ecs:DescribeImages |
get |
Imagem.
Imagem.
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| RegionId |
string |
Sim |
O ID da região da imagem. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente. |
cn-hangzhou |
| Status |
string |
Não |
O status da imagem. Valores válidos:
Valor padrão: Available. Quando Usable é usado, Status é obrigatório e não possui valor padrão. Nota
Este parâmetro aceita vários valores ao mesmo tempo, separados por vírgulas (,). Quando o valor é definido como ALL, as imagens em todos os status são consultadas. ALL não pode ser usado junto com outros valores de status. |
Available |
| ImageId |
string |
Não |
O ID da imagem. |
m-bp1g7004ksh0oeuc**** |
| ShowExpired |
boolean |
Não |
Especifica se a imagem por assinatura excedeu seu período de uso. |
false |
| SnapshotId |
string |
Não |
O ID do snapshot usado para criar a imagem personalizada. |
s-bp17ot2q7x72ggtw**** |
| ImageName |
string |
Não |
O nome da imagem. Há suporte para pesquisa aproximada. |
testImageName |
| ImageFamily |
string |
Não |
O nome da família de imagens. Você pode definir este parâmetro para filtrar imagens que pertencem à família de imagens especificada. Valor padrão: vazio. Nota
Para obter informações sobre famílias de imagens associadas a imagens públicas da Alibaba Cloud, consulte Visão geral das imagens públicas. |
hangzhou-daily-update |
| ImageOwnerAlias |
string |
Não |
A origem da imagem. Valores válidos:
Valor padrão: vazio. Nota
Um valor vazio indica que as imagens com os valores system, self e others são retornadas. |
self |
| InstanceType |
string |
Não |
O tipo de instância para o qual você deseja consultar as imagens disponíveis. |
ecs.g5.large |
| Usable |
boolean |
Não |
Especifica se a imagem está disponível. Nota
Uma imagem disponível indica que a imagem pode ser usada imediatamente para criar uma instância. Para obter mais cenários de disponibilidade, consulte Disponibilidade instantânea de imagem. |
true |
| IsSupportIoOptimized |
boolean |
Não |
Especifica se a imagem pode ser executada em instâncias otimizadas para E/S. |
true |
| IsSupportCloudinit |
boolean |
Não |
Especifica se a imagem oferece suporte ao cloud-init. |
true |
| OSType |
string |
Não |
O tipo de sistema operacional da imagem. Valores válidos:
|
linux |
| Architecture |
string |
Não |
A arquitetura da imagem. Valores válidos:
|
i386 |
| PageNumber |
integer |
Não |
O número da página dos recursos. Valor mínimo: 1. Valor padrão: 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página para consultas paginadas. Defina este parâmetro para especificar o número de entradas a serem retornadas em cada página. Valor máximo: 100. Valor padrão: 10. |
10 |
| Usage |
string |
Não |
Especifica se a imagem está em execução em instâncias ECS. Valores válidos:
|
instance |
| DryRun |
boolean |
Não |
Especifica se deve ser realizado apenas um dry run, sem executar a solicitação real.
Valor padrão: false. |
false |
| ActionType |
string |
Não |
O cenário no qual a imagem será usada. Valores válidos:
|
CreateEcs |
| ResourceGroupId |
string |
Não |
O ID do grupo de recursos ao qual a imagem personalizada pertence. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1000. Nota
Não há suporte para filtragem pelo grupo de recursos padrão. |
rg-bp67acfmxazb4p**** |
| Tag |
array<object> |
Não |
A lista de tags. |
|
|
object |
Não |
As informações da tag. |
||
| key |
string |
Não |
A chave da tag da imagem. Nota
[Deprecated] Este parâmetro será descontinuado. Para melhor compatibilidade, use Tag.N.Key em seu lugar. |
null |
| Key |
string |
Não |
A chave da tag da imagem. Valores válidos de N: 1 a 20. Ao usar uma única tag para filtrar recursos, a contagem de recursos com esta tag não pode exceder 1000. Ao usar várias tags para filtrar recursos, a contagem de recursos anexados a todas as tags especificadas não pode exceder 1000. Se a contagem de recursos exceder 1000, chame a operação ListTagResources para consultar os recursos. |
TestKey |
| Value |
string |
Não |
O valor da tag da imagem. Valores válidos de N: 1 a 20. |
TestValue |
| value |
string |
Não |
O valor da tag da imagem. Nota
[Deprecated] Este parâmetro será descontinuado. Para melhor compatibilidade, use Tag.N.Value em seu lugar. |
null |
| Filter |
array<object> |
Não |
A lista de condições de filtro ao consultar recursos. |
|
|
object |
Não |
A condição de filtro ao consultar recursos. |
||
| Key |
string |
Não |
A chave de filtro ao consultar recursos. Valores válidos:
Valor padrão: null. |
CreationStartTime |
| Value |
string |
Não |
O valor do filtro ao consultar recursos.
Valor padrão: null. |
2017-12-05T22:40Z |
| IsPublic |
boolean |
Não |
Especifica se devem ser consultadas imagens da comunidade publicadas. Valores válidos:
Valor padrão: false. |
false |
| ImageOwnerId |
integer |
Não |
O ID da conta da Alibaba Cloud à qual a imagem pertence. Este parâmetro só entra em vigor quando você consulta imagens compartilhadas ou imagens da comunidade. |
20169351435666**** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| PageSize |
integer |
O número de entradas por página. |
1 |
| PageNumber |
integer |
O número da página. |
1 |
| RequestId |
string |
O ID da solicitação. |
66189103-EDB2-43E2-BB60-BFF2B62F4EB8 |
| TotalCount |
integer |
O número total de imagens. |
1 |
| RegionId |
string |
O ID da região da imagem. |
cn-hangzhou |
| Images |
object |
||
| Image |
array<object> |
A coleção de informações de imagens. |
|
|
array<object> |
As informações da imagem. |
||
| CreationTime |
string |
A hora em que a imagem foi criada. A hora segue o padrão ISO 8601 em UTC. |
2019-11-15T06:07:05Z |
| Status |
string |
O status da imagem. Valores válidos:
|
Available |
| ImageFamily |
string |
O nome da família de imagens. |
hangzhou-daily-update |
| Progress |
string |
O progresso de criação da imagem, em porcentagem. |
100% |
| IsCopied |
boolean |
Indica se a imagem é uma cópia de outra imagem. |
false |
| IsSupportIoOptimized |
boolean |
Indica se a imagem pode ser usada em instâncias otimizadas para E/S. |
true |
| ImageOwnerAlias |
string |
A origem da imagem. Valores válidos:
|
self |
| IsSupportCloudinit |
boolean |
Indica se o cloud-init é suportado. |
true |
| ImageVersion |
string |
A versão da imagem. |
2 |
| Usage |
string |
O tipo de recurso que referencia a imagem. Valores válidos:
|
none |
| IsSelfShared |
string |
Indica se a imagem personalizada foi compartilhada com outros usuários. |
true |
| Description |
string |
A descrição da imagem. |
Log de arquivamento do Oracle |
| Size |
integer |
O tamanho da imagem. Unidade: GiB. Importante
Se a imagem contiver discos de dados, este parâmetro indica apenas o tamanho do snapshot do disco do sistema associado à imagem.
|
60 |
| ResourceGroupId |
string |
O ID do grupo de recursos ao qual a imagem pertence. |
rg-bp67acfmxazb4p**** |
| Platform |
string |
A plataforma do sistema operacional. |
Windows Server 2016 |
| OSNameEn |
string |
O nome em inglês do sistema operacional. |
Windows Server 2016 Data Center Edition 64bit Chinese Edition |
| ImageName |
string |
O nome da imagem. |
testImageName |
| OSName |
string |
O nome em chinês do sistema operacional. |
Windows Server 2016 数据中心版 64位中文版 |
| ImageId |
string |
O ID da imagem. |
m-bp1g7004ksh0oeuc**** |
| OSType |
string |
O tipo do sistema operacional. Valores válidos:
|
windows |
| IsSubscribed |
boolean |
Indica se você assinou os termos de serviço da imagem do Alibaba Cloud Marketplace associada ao código do produto. |
false |
| ProductCode |
string |
O código do produto da imagem do Alibaba Cloud Marketplace. |
test000**** |
| Architecture |
string |
O tipo de arquitetura do sistema da imagem. Valores válidos:
|
x86_64 |
| BootMode |
string |
O modo de inicialização da imagem. Valores válidos:
Para obter mais informações sobre os modos de inicialização de imagens, consulte Modo de inicialização da imagem. |
BIOS |
| DiskDeviceMappings |
object |
||
| DiskDeviceMapping |
array<object> |
A coleção de relações de mapeamento de disco para snapshot na imagem. |
|
|
object |
A relação de mapeamento de disco para snapshot na imagem. |
||
| Type |
string |
O tipo da imagem. |
system |
| ImportOSSBucket |
string |
O bucket do OSS que contém a imagem importada. |
testEcsImport |
| Progress |
string |
O progresso da tarefa de cópia de imagem para uma imagem que está sendo copiada. |
32% |
| SnapshotId |
string |
O ID do snapshot. |
s-bp17ot2q7x72ggtw**** |
| ImportOSSObject |
string |
O objeto do OSS que contém a imagem importada. |
imageImport |
| Device |
string |
O nome do dispositivo do disco, como /dev/xvdb. |
/dev/xvda |
| Size |
string |
O tamanho do disco. Unidade: GiB. |
60 |
| RemainTime |
integer |
O tempo restante da tarefa de cópia de imagem para uma imagem que está sendo copiada. Unidade: segundos. |
233 |
| Format |
string |
O formato da imagem. |
qcow2 |
| Encrypted |
boolean |
Indica se a imagem está criptografada. |
true |
| Tags |
object |
||
| Tag |
array<object> |
A lista de pares chave-valor de tags da imagem. |
|
|
object |
O par chave-valor de tag da imagem. |
||
| TagValue |
string |
O valor da tag da imagem. |
Oracle |
| TagKey |
string |
A chave da tag da imagem. |
DTS |
| IsPublic |
boolean |
Indica se a imagem é pública. As imagens públicas incluem imagens públicas fornecidas pelo Alibaba Cloud e imagens personalizadas que você publicou como imagens da comunidade. Valores válidos:
|
false |
| ImageOwnerId |
integer |
O ID da conta da Alibaba Cloud à qual a imagem pertence. Este parâmetro só entra em vigor quando você consulta imagens compartilhadas ou imagens da comunidade. |
1234567890 |
| LoginAsNonRootSupported |
boolean |
Indica se a imagem suporta login como um usuário não root. Valores válidos:
|
false |
| SupplierName |
string |
O nome da empresa que foi verificada para a imagem da comunidade. |
TestName |
| DetectionOptions |
object |
Os resultados da detecção da imagem. |
|
| Status |
string |
O status da tarefa de detecção da imagem. Valores válidos:
|
Processing |
| Items |
object |
||
| Item |
array<object> |
A lista de itens de detecção da imagem. |
|
|
object |
O item de detecção da imagem. |
||
| Name |
string |
O nome do item de detecção da imagem. |
Nvme |
| Value |
string |
O resultado do item de detecção da imagem. |
Supported |
| RiskLevel |
string |
O nível de risco do item de detecção de imagem personalizada importada. Este campo é retornado apenas quando existe um risco. Valores válidos:
|
High |
| RiskCode |
string |
O defeito potencial do item de detecção. |
NVMe.NotInstalled |
| Features |
object |
As propriedades relacionadas aos recursos da imagem. |
|
| NvmeSupport |
string |
Indica se a imagem suporta NVMe. Valores válidos:
|
supported |
| ImdsSupport |
string |
O modo de acesso aos metadados da imagem. Valores válidos:
|
v2 |
| CpuOnlineUpgrade |
string |
Indica se o upgrade online de CPU é suportado. Valores válidos:
|
supported |
| CpuOnlineDowngrade |
string |
Indica se o downgrade online de CPU é suportado. Valores válidos:
|
supported |
| MemoryOnlineUpgrade |
string |
Indica se o upgrade online de memória é suportado. Valores válidos:
|
unsupported |
| MemoryOnlineDowngrade |
string |
Indica se o downgrade online de memória é suportado. Valores válidos:
|
unsupported |
| LicenseType |
string |
O tipo de licença. Esta propriedade determina o método de cobrança e a lógica de ativação para instâncias ECS criadas a partir desta imagem. Esta propriedade é significativa apenas para imagens do Windows Server. Valores válidos:
|
BYOL |
| Usable |
boolean |
Indica se a imagem está utilizável. Valores válidos:
|
true |
| SecureBootOptions |
object |
Os parâmetros relacionados ao Secure Boot. |
|
| SecureBootSupport |
string |
Indica se a imagem suporta o Secure Boot. Valores válidos:
|
supported |
Exemplos
Resposta de sucesso
JSON formato
{
"PageSize": 1,
"PageNumber": 1,
"RequestId": "66189103-EDB2-43E2-BB60-BFF2B62F4EB8",
"TotalCount": 1,
"RegionId": "cn-hangzhou",
"Images": {
"Image": [
{
"CreationTime": "2019-11-15T06:07:05Z",
"Status": "Available",
"ImageFamily": "hangzhou-daily-update",
"Progress": "100%",
"IsCopied": false,
"IsSupportIoOptimized": true,
"ImageOwnerAlias": "self",
"IsSupportCloudinit": true,
"ImageVersion": "2",
"Usage": "none",
"IsSelfShared": "true",
"Description": "Archive log for Oracle",
"Size": 60,
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"Platform": "Windows Server 2016",
"OSNameEn": "Windows Server 2016 Data Center Edition 64bit Chinese Edition",
"ImageName": "testImageName",
"OSName": "Windows Server 2016 数据中心版 64位中文版",
"ImageId": "m-bp1g7004ksh0oeuc****",
"OSType": "windows",
"IsSubscribed": false,
"ProductCode": "test000****",
"Architecture": "x86_64",
"BootMode": "BIOS",
"DiskDeviceMappings": {
"DiskDeviceMapping": [
{
"Type": "system",
"ImportOSSBucket": "testEcsImport",
"Progress": "32%",
"SnapshotId": "s-bp17ot2q7x72ggtw****",
"ImportOSSObject": "imageImport",
"Device": "/dev/xvda",
"Size": "60",
"RemainTime": 233,
"Format": "qcow2",
"Encrypted": true
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "Oracle",
"TagKey": "DTS"
}
]
},
"IsPublic": false,
"ImageOwnerId": 1234567890,
"LoginAsNonRootSupported": false,
"SupplierName": "TestName",
"DetectionOptions": {
"Status": "Processing",
"Items": {
"Item": [
{
"Name": "Nvme",
"Value": "Supported",
"RiskLevel": "High",
"RiskCode": "NVMe.NotInstalled"
}
]
}
},
"Features": {
"NvmeSupport": "supported",
"ImdsSupport": "v2",
"CpuOnlineUpgrade": "supported",
"CpuOnlineDowngrade": "supported",
"MemoryOnlineUpgrade": "unsupported",
"MemoryOnlineDowngrade": "unsupported"
},
"LicenseType": "BYOL",
"Usable": true,
"SecureBootOptions": {
"SecureBootSupport": "supported"
}
}
]
}
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | InvalidImageOwnerAlias.ValueNotSupported | The specified ImageOwnerAlias value is not supported. | O alias do proprietário da imagem especificado é inválido. Verifique se o parâmetro está correto. |
| 400 | InvalidParamter | Invalid Parameter. | A solicitação contém parâmetros inválidos. |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | O Tag.N.Key e o Tag.N.Value especificados não correspondem. |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | A tag especificada está fora do intervalo válido. |
| 400 | InvalidInstanceType.ValueNotSupported | The specified instance type %s does not exist. You can use the DescribeInstanceTypes API to query the available instance types. | O tipo de instância especificado é inválido porque está fora do intervalo disponível. |
| 400 | InvalidFilterValue.NetworkType | The specified networkType value in the Filter is invalid. | O valor do tipo de rede especificado no filtro é inválido. |
| 400 | InvalidOperation.ImageOwnerIdUnsupported | The parameter "ImageOwnerId" is not supported in this context, it is only valid when querying shared images or community images. | O parâmetro ImageOwnerId não é suportado aqui. Este parâmetro é válido apenas ao consultar imagens compartilhadas ou imagens da comunidade. |
| 400 | InvalidImageOwnerAlias.PublicImageUnsupported | When querying images, the parameter ImageOwnerAlias should be others while specified parameter IsPublic is true. | Quando o parâmetro IsPublic é definido como true para consultas de imagem, o parâmetro ImageOwnerAlias deve ser definido como others. |
| 400 | MissingParameter.Status | The specified parameter Status is not supplied. | O parâmetro Status especificado não pode estar vazio. |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | CurrentAccount.NotSupportPublicImage | Public image is not supported for current account. | O usuário atual não tem permissão para usar imagens públicas. |
| 404 | InvalidFilterKey.NotFound | The specified Filter Key is not found. | O parâmetro de hora de início ou hora de expiração especificado é inválido. |
| 404 | InvalidFilterValue | The specified Filter Value is not valid. | O formato de hora inserido é inválido. |
| 404 | InvalidUsage | The specified Usage is not valid. | O tipo de recurso especificado com uma relação de referência (image, disk, image_disk, none) é inválido. |
| 404 | InvalidOSType | The specified OSType is not valid. | O sistema operacional especificado não é suportado. |
| 404 | InvalidArchitecture | The specified Architecture is not valid. | A arquitetura especificada não existe. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.