DescribeImagePipelines - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta os detalhes de um ou mais modelos de imagem.

Descrição da operação

Você pode definir o token de consulta NextToken, que é o valor do parâmetro NextToken retornado pela última chamada à operação DescribeImagePipelines, e usar MaxResults para especificar o número máximo de entradas a serem retornadas em uma única página.

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

ecs:DescribeImagePipelines

get

*ImagePipeline.

acs:ecs:{#regionId}:{#accountId}:imagepipeline/*

*ImagePipeline.

acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1.000. Nota A filtragem pelo grupo de recursos padrão não é suportada.	rg-bp67acfmxazb4p****
Tag	array<object>	Não	As tags.
	object	Não	As tags.
Key	string	Não	A chave da tag. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag. Valores válidos de N: 1 a 20.	TestValue
Name	string	Não	O nome do modelo de imagem.	testImagePipeline
NextToken	string	Não	O token de consulta. O valor é o valor do parâmetro NextToken retornado pela chamada anterior a esta operação. Você não precisa especificar este parâmetro ao chamar esta operação pela primeira vez.	AAAAAdDWBF2****
MaxResults	integer	Não	O número máximo de entradas a serem retornadas por página para paginação em uma consulta paginada. Valores válidos: 1 a 500. Valor padrão: 50.	50
ImagePipelineId	array	Não	O ID do modelo de imagem. Valores válidos de N: 1 a 20.	ip-2ze5tsl5bp6nf2b3****
	string	Não	O ID do modelo de imagem. Valores válidos de N: 1 a 20.	ip-2ze5tsl5bp6nf2b3****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de consulta retornado pela chamada atual. Para obter mais informações sobre como usar o token, consulte a descrição da operação.	AAAAAdDWBF2****
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de modelos de imagem retornados.	1
MaxResults	integer	O número máximo de entradas retornadas por página para paginação em uma consulta paginada.	50
ImagePipeline	object
ImagePipelineSet	array<object>	A lista de modelos de imagem.
	array<object>
CreationTime	string	A hora em que o modelo de imagem foi criado. A hora segue o padrão ISO 8601 e é exibida em UTC.	2020-11-24T06:00:00Z
DeleteInstanceOnFailure	boolean	Especifica se a instância intermediária deve ser liberada se a compilação da imagem falhar.	true
InstanceType	string	O tipo de instância.	ecs.g6.large
InternetMaxBandwidthOut	integer	A largura de banda pública de saída da instância intermediária. Unidade: Mbit/s.	0
ImagePipelineId	string	O ID do modelo de imagem.	ip-2ze5tsl5bp6nf2b3****
VSwitchId	string	O ID do vSwitch na VPC.	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	O tamanho do disco do sistema da instância intermediária. Unidade: GiB.	40
Description	string	A descrição.	This is description.
BaseImage	string	A imagem de origem. Se BaseImageType estiver definido como IMAGE, o valor deste parâmetro é o ID da imagem personalizada. Se BaseImageType estiver definido como IMAGE_FAMILY, o valor deste parâmetro é o nome da família de imagens.	m-bp67acfmxazb4p****
ResourceGroupId	string	O ID do grupo de recursos.	rg-bp67acfmxazb4p****
ImageName `deprecated`	string	[Deprecated] O prefixo do nome da imagem de destino. Use ImageOptions.ImageName em seu lugar.	testImageName
BaseImageType	string	O tipo da imagem de origem. Valores válidos: IMAGE: imagem personalizada IMAGE_FAMILY: família de imagens	IMAGE
Name	string	O nome do modelo de imagem.	testImagePipeline
BuildContent	string	O conteúdo do modelo de imagem.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
Tags	object
Tag	array<object>	A lista de pares chave-valor de tag.
	object
TagValue	string	O valor da tag.	TestValue
TagKey	string	A chave da tag.	TestKey
ToRegionIds	object
ToRegionId	array	A lista de regiões para as quais a imagem de destino deve ser distribuída.
	string	A lista de regiões para as quais a imagem de destino deve ser distribuída.	["cn-hangzhou"]
AddAccounts	object
AddAccount	array	O ID da conta Alibaba Cloud para compartilhamento da imagem de destino.
	string	O ID da conta Alibaba Cloud para compartilhamento da imagem de destino.	["1234567890"]
RepairMode	string	A opção de reparo no modelo de imagem. Valores válidos: Standard: modo de reparo padrão. O pacote de reparo padrão para sistemas Linux inclui: GUESTOS.CloudInit GUESTOS.Dhcp GUESTOS.Virtio GUESTOS.OnlineResizeFS GUESTOS.Grub GUESTOS.Fstab GUESTOS.Nvme O pacote de reparo padrão para sistemas Windows inclui: GUESTOS.Virtio GUESTOS.Update GUESTOS.Hotfix GUESTOS.Server GUESTOS.Bcd GUESTOS.Disk GUESTOS.Bootmgr GUESTOS.OSLoader GUESTOS.Vminit All: modo de reparo completo. O pacote de reparo completo para sistemas Linux inclui os seguintes itens, além daqueles no pacote de reparo padrão: GUESTOS.Selinux GUESTOS.SecurityCenterAgent O pacote de reparo completo para sistemas Windows inclui os seguintes itens, além daqueles no pacote de reparo padrão: GUESTOS.Server Customized: modo de reparo personalizado. Neste modo, os itens de reparo no pacote de reparo são especificados pelo parâmetro RepairItem. Nota À medida que os recursos de detecção e reparo continuam a melhorar, os itens de reparo incluídos podem aumentar. Para obter mais informações sobre os significados específicos dos itens de reparo, consulte Visão geral da verificação de imagem.	Standard
RepairItems	object
RepairItem	array	Os itens de reparo de imagem. Itens de reparo suportados pelo Linux: fstab: corrige problemas de configuração de anexação de disco grub: corrige problemas de configuração de inicialização do GRUB dhcp: corrige problemas de DHCP de rede selinux: corrige problemas do Security-Enhanced Linux (SELinux) growpart: corrige problemas de expansão automática online da partição raiz cloudinit: instala o serviço de inicialização cloud-init aegis: instala o serviço de agente do Security Center nvme: corrige problemas de driver NVMe virtio: corrige problemas de driver virtio standardizedtimezone: corrige problemas de fuso horário padrão Itens de reparo suportados pelo Windows: bcd: corrige problemas de arquivo de dados de Configuração de Inicialização hotfix: corrige problemas de patch do Windows disk: corrige problemas de configurações de disco update: corrige problemas do processo de Atualização server: corrige problemas de configuração de serviço bootmgr: corrige problemas do Gerenciador de Inicialização do Windows vminit: corrige problemas do agente de inicialização do Windows osloader: corrige problemas do OS Loader do Windows virtio: corrige problemas de driver virtio standardizedtimezone: corrige problemas de fuso horário padrão
	string	O item de reparo de imagem.	fstab
TestContent	string	O conteúdo do modelo de teste de imagem.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
ImageFamily `deprecated`	string	[Deprecated] A família da imagem de destino. Use ImageOptions.ImageFamily em seu lugar.	family
NvmeSupport `deprecated`	string	[Deprecated] Especifica se a imagem de destino compilada suporta NVMe. Use ImageOptions.ImageFeatures.NvmeSupport em seu lugar.	auto
ImportImageOptions	object	As propriedades e configurações da imagem importada.
Architecture	string	A arquitetura do sistema. Valores válidos: x86_64 arm64	x86_64
OSType	string	O tipo de sistema operacional. Valores válidos: windows linux	linux
Platform	string	A versão do sistema operacional. Valores válidos: Aliyun Anolis CentOS Ubuntu CoreOS SUSE Debian OpenSUSE FreeBSD RedHat Kylin UOS Fedora Fedora CoreOS CentOS Stream AlmaLinux Rocky Linux Gentoo Customized Linux Others Linux Windows Server 2022 Windows Server 2019 Windows Server 2016 Windows Server 2012 Windows Server 2008 Windows Server 2003 Other Windows	Aliyun
BootMode	string	O modo de inicialização da imagem importada. Valores válidos: BIOS: modo de inicialização BIOS UEFI: modo de inicialização UEFI	BIOS
LicenseType	string	O tipo de licença usada para ativar o sistema operacional após a importação da imagem. Valores válidos: Auto: O Alibaba Cloud detecta o sistema operacional de origem e atribui uma licença. No modo automático, o sistema primeiro verifica se a Platform especificada por você possui uma licença de um canal oficial do Alibaba Cloud e a atribui à imagem importada. Se nenhuma licença desse tipo estiver disponível, o sistema mudará para o método Bring Your Own License (BYOL). Aliyun: usa uma licença de um canal oficial do Alibaba Cloud com base na Platform especificada por você. BYOL: usa a licença fornecida pelo sistema operacional de origem. Se você usar BYOL, deverá garantir que sua chave de licença seja suportada no Alibaba Cloud.	Auto
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	A lista de informações sobre as imagens personalizadas criadas. Se N estiver definido como 1, o disco é um disco do sistema. Se N estiver definido como 2 a 17, o disco é um disco de dados.
	object
OSSBucket	string	O bucket do OSS onde o arquivo de imagem está armazenado.	ecsimageos
OSSObject	string	O nome (chave) do arquivo de imagem salvo no bucket do OSS após o upload da imagem para o bucket.	CentOS_5.4_32.raw
Format	string	O formato da imagem. Valores válidos: RAW VHD QCOW2	RAW
DiskImageSize	integer	O tamanho da imagem personalizada após a importação da imagem. O espaço consiste no disco do sistema e nos discos de dados. Você deve garantir que o tamanho do disco do sistema seja maior ou igual ao tamanho do arquivo de imagem importado. Valores válidos: Se N estiver definido como 1, o disco é um disco do sistema. Valores válidos: 1 a 2048. Unidade: GiB. Se N estiver definido como 2 a 17, o disco é um disco de dados. Valores válidos: 1 a 2048. Unidade: GiB. Após fazer o upload do arquivo de imagem de origem para o OSS, você pode visualizar o tamanho do arquivo de imagem no bucket do OSS.	40
Features	object	As propriedades relacionadas aos recursos da imagem.
NvmeSupport	string	Especifica se a imagem importada suporta NVMe. Valores válidos: supported: suportado. As instâncias criadas a partir desta imagem suportam o protocolo NVMe. unsupported: não suportado. As instâncias criadas a partir desta imagem não suportam o protocolo NVMe.	supported
ImdsSupport	string	O modo de acesso aos metadados da imagem. Valores válidos: v1: Ao criar uma instância ECS a partir desta imagem, você não pode definir o modo de acesso aos metadados como enforced. v2: Ao criar uma instância ECS a partir desta imagem, você pode definir o modo de acesso aos metadados como enforced. Valor padrão: v1.	v2
RetainImportedImage	boolean	[Deprecated] Use ImportImageOptions.RetentionStrategy em seu lugar.	false
RetentionStrategy	string	A política de retenção de dados para a imagem importada. Valores válidos: RetainOnlySuccessful: A imagem é retida apenas se a compilação for bem-sucedida. RetainOnlyFailed: A imagem é retida apenas se a compilação falhar. RetainAlways: A imagem é sempre retida, independentemente do resultado da compilação. RetainNever: A imagem nunca é retida, independentemente do resultado da compilação. Valor padrão: RetainNever.	RetainAlways
ImageName	string	O nome da imagem importada.	fvt-ecs-imported-image-1812b2d7
Description	string	A descrição da imagem importada.	created by acc
RoleName	string	O nome da função RAM usada quando a imagem é importada.	AliyunECSImageImportDefaultRole
ImportImageTags	object
ImportImageTag	array<object>
	object	Os pares chave-valor de tag da imagem importada.
Key	string	A chave da tag da imagem.	testKey
Value	string	O valor da tag da imagem.	testValue
AdvancedOptions	object	As configurações avançadas.
RetainCloudAssistant	boolean	Especifica se o Cloud Assistant deve ser retido. Durante o processo de compilação, o sistema instala automaticamente o Cloud Assistant na instância intermediária para executar comandos. Você pode escolher se deseja retê-lo na imagem de destino compilada. Valores válidos: true: retém o Cloud Assistant. false: não retém o Cloud Assistant. Nota Esta configuração não afeta o Cloud Assistant que já está instalado em sua imagem.	true
ImageNameSuffix	string	Especifica se a adição automática de um sufixo ao nome da imagem de destino deve ser desativada. Valores válidos: disable: desativado.	disable
ImageOptions	object	As propriedades da imagem de destino.
ImageName	string	O prefixo do nome da imagem de destino.	imageName
ImageFamily	string	A família da imagem de destino.	family
Description	string	A descrição da imagem de destino.	description.
ImageFeatures	object	As propriedades relacionadas aos recursos da imagem de destino.
NvmeSupport	string	Especifica se a imagem de destino compilada suporta NVMe. Valores válidos: supported: suportado. As instâncias criadas a partir desta imagem suportam o protocolo NVMe. unsupported: não suportado. As instâncias criadas a partir desta imagem não suportam o protocolo NVMe. auto: detecção automática. O sistema detecta automaticamente se o driver NVMe está instalado em sua imagem. Esta detecção ocorre antes da fase de compilação. Se você instalar ou desinstalar o driver NVMe durante a compilação, o resultado pode ser impreciso. Recomendamos que você defina este parâmetro como supported ou unsupported com base no conteúdo da compilação.	auto
ImageTags	object
ImageTag	array<object>	As tags da imagem de destino.
	object
TagKey	string	A chave da tag.	testKey
TagValue	string	O valor da tag.	testValue

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImagePipeline": {
    "ImagePipelineSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "DeleteInstanceOnFailure": true,
        "InstanceType": "ecs.g6.large",
        "InternetMaxBandwidthOut": 0,
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "VSwitchId": "vsw-bp67acfmxazb4p****",
        "SystemDiskSize": 40,
        "Description": "Esta é a descrição",
        "BaseImage": "m-bp67acfmxazb4p****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ImageName": "testImageName",
        "BaseImageType": "IMAGE",
        "Name": "testImagePipeline",
        "BuildContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "Standard",
        "RepairItems": {
          "RepairItem": [
            "fstab"
          ]
        },
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "ImageFamily": "família",
        "NvmeSupport": "auto",
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "OSType": "linux",
          "Platform": "Aliyun",
          "BootMode": "BIOS",
          "LicenseType": "Auto",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "OSSBucket": "ecsimageos",
                "OSSObject": "CentOS_5.4_32.raw",
                "Format": "RAW",
                "DiskImageSize": 40
              }
            ]
          },
          "Features": {
            "NvmeSupport": "supported",
            "ImdsSupport": "v2"
          },
          "RetainImportedImage": false,
          "RetentionStrategy": "RetainAlways",
          "ImageName": "fvt-ecs-imported-image-1812b2d7",
          "Description": "criado pela conta",
          "RoleName": "AliyunECSImageImportDefaultRole",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "testKey",
                "Value": "testValue"
              }
            ]
          }
        },
        "AdvancedOptions": {
          "RetainCloudAssistant": true,
          "ImageNameSuffix": "disable"
        },
        "ImageOptions": {
          "ImageName": "imageName",
          "ImageFamily": "família",
          "Description": "description",
          "ImageFeatures": {
            "NvmeSupport": "auto"
          },
          "ImageTags": {
            "ImageTag": [
              {
                "TagKey": "testKey",
                "TagValue": "testValue"
              }
            ]
          }
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidImagePipelineIdSize.ExceededMaxNumber	%s	O número de valores ImagePipelineId.N especificados excede o limite superior. Valores válidos de N: 1 a 20.
400	InvalidName.Malformed	%s
403	Invalid.NextToken	The specified NextToken is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.