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

Consulta os detalhes de um ou mais componentes de imagem.

Descrição da operação

Você pode definir NextToken com o valor de NextToken retornado na chamada anterior para DescribeImageComponents e definir MaxResults para especificar o número máximo de entradas por 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:DescribeImageComponents

get

*ImageComponent.

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

*ImageComponent.

acs:ecs:{#regionId}:{#accountId}:imagecomponent/{#imagecomponentId}

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 DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos. Se você usar este parâmetro para filtrar recursos, a contagem de recursos não poderá exceder 1000.\n\n>A filtragem pelo grupo de recursos padrão não é suportada.	rg-bp67acfmxazb4p****
Tag	array<object>	Não	As tags.
	object	Não
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 componente de imagem. Apenas a correspondência exata é suportada.	testComponent
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor de `NextToken` retornado na chamada anterior. Você não precisa definir este parâmetro para a primeira solicitação.	AAAAAdDWBF2****
MaxResults	integer	Não	O número máximo de entradas por página para consultas paginadas. Valores válidos: 1 a 500.\n\nValor padrão: 50.	50
Owner	string	Não	O tipo de componente de imagem. Valores válidos:\n\n- SELF: componentes de imagem personalizados que você criou.\n- ALIYUN: componentes de sistema fornecidos pela Alibaba Cloud.	SELF
ImageComponentId	array	Não	O ID do componente de imagem a ser consultado. Valores válidos de N: 1 a 20.	ic-bp67acfmxazb4p****
	string	Não	O ID do componente de imagem a ser consultado. Valores válidos de N: 1 a 20.	ic-bp67acfmxazb4p****
ComponentType	string	Não	O tipo de componente.\n\nValores válidos:\n- Build\n- Test.	Build
SystemType	string	Não	O sistema operacional suportado pelo componente.\n\nValores válidos:\n- Linux\n- Windows.	Linux
ComponentVersion	string	Não	O número da versão do componente no formato major.minor.patch. Cada parte é um número inteiro não negativo. Você também pode usar o caractere curinga (*) para substituir uma parte para correspondência aproximada.\n>Este parâmetro só entra em vigor quando Name é especificado.	1.0.*

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação retornado nesta chamada. Para obter mais informações sobre como usar este 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 componentes de imagem retornados.	1
MaxResults	integer	O número máximo de entradas por página para consultas paginadas.	50
ImageComponent	object
ImageComponentSet	array<object>	A lista de detalhes dos componentes de imagem.
	array<object>
CreationTime	string	A hora em que o componente foi criado. A hora é exibida no formato ISO 8601 em UTC.	2020-11-24T06:00:00Z
Description	string	A descrição.	Esta é a descrição
SystemType	string	O sistema operacional suportado pelo componente.	Linux
ImageComponentId	string	O ID do componente de imagem.	ic-bp67acfmxazb4p****
ComponentType	string	O tipo de componente.	Build
ResourceGroupId	string	O ID do grupo de recursos.	rg-bp67acfmxazb4p****
Name	string	O nome do componente.	testComponent
Content	string	O conteúdo do componente.	Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
Owner	string	O tipo de componente de imagem. Valores válidos:\n\n- SELF: componentes de imagem personalizados que você criou.\n- ALIYUN: componentes de sistema fornecidos pela Alibaba Cloud.	SELF
Tags	object
Tag	array<object>	A lista de pares chave-valor de tags.
	object
TagValue	string	O valor da tag.	TestValue
TagKey	string	A chave da tag.	TestKey
ComponentVersion	string	O número da versão do componente.	1.0.0
Parameters	object
Parameter	array<object>	A lista de parâmetros incluídos no componente de imagem.
	object
Name	string	O nome do parâmetro.	paramName
Type	string	O tipo de parâmetro.\n\nValores válidos:\n- String\n- Number\n- Boolean.	String
DefaultValue	string	O valor padrão do parâmetro.	paramDefaultValue

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImageComponent": {
    "ImageComponentSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "Description": "This is description.",
        "SystemType": "Linux",
        "ImageComponentId": "ic-bp67acfmxazb4p****",
        "ComponentType": "Build",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Name": "testComponent",
        "Content": "Tasks:\n  - Name: HelloWorld\n    Action: RunShellCommand\n    Properties:\n      commandContent: echo hello world\n",
        "Owner": "SELF",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ComponentVersion": "1.0.0",
        "Parameters": {
          "Parameter": [
            {
              "Name": "paramName",
              "Type": "String",
              "DefaultValue": "paramDefaultValue"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.Owner	The specified parameter \"Owner\" is not valid.
400	InvalidImageComponentIdSize.ExceededMaxNumber	%s	O valor do parâmetro especificado é inválido. Para obter mais informações, consulte o valor real retornado para o placeholder %s na mensagem de erro.
400	InvalidSystemType.NotSupportedValue	%s.	O tipo de sistema especificado é inválido.
400	InvalidComponentType.NotSupportedValue	%s.	O tipo de componente especificado é inválido.
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.	A versão do componente especificada é inválida.
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.