ListProvisionedProducts - Service Catalog: Central de Documentação do Alibaba Cloud

Consulta instâncias de produto.

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

servicecatalog:ListProvisionedProducts

get

*ProvisionedProduct

acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*

servicecatalog:UserLevel

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Filters	array<object>	Não	As condições de filtro.
	object	Não
Key	string	Não	O nome da condição de filtro. Valores válidos: ProvisionedProductName: realiza correspondência exata pelo nome da instância de produto. Os nomes das instâncias de produto não diferenciam maiúsculas de minúsculas. FullTextSearch: realiza pesquisa de texto completo pelo nome da instância de produto. Correspondência aproximada é suportada.	ProvisionedProductName
Value	string	Não	O valor da condição de filtro.	DEMO-ECS-Instance
SortBy	string	Não	O campo usado para ordenar os dados consultados. Defina o valor como CreateTime, que especifica a hora em que a instância de produto foi criada.	CreateTime
SortOrder	string	Não	O método de ordenação. Valores válidos: Asc: ordem crescente. Desc (padrão): ordem decrescente.	Desc
PageNumber	integer	Não	O número da página a ser retornada. As páginas começam a partir da página 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 10.	10
AccessLevelFilter	string	Não	O filtro de acesso. Valores válidos: User: consulta as instâncias de produto criadas pelo solicitante atual. Este é o valor padrão. Account: consulta as instâncias de produto que pertencem à conta Alibaba Cloud atual.	User

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
ProvisionedProductDetails	array<object>	As instâncias de produto.
	object	Os detalhes da instância de produto.
ProvisionedProductName	string	O nome da instância de produto.	DEMO-ECS-Instance
ProvisionedProductId	string	O ID da instância de produto.	pp-bp1ddg1n2a****
ProvisionedProductArn	string	O Alibaba Cloud Resource Name (ARN) da instância de produto.	acs:servicecatalog:cn-hangzhou:146611588617**:provisionedproduct/pp-bp1ddg1n2a**
ProductId	string	O ID do produto.	prod-bp18r7q127****
ProductName	string	O nome do produto.	DEMO-Create ECS
ProductVersionId	string	O ID da versão do produto.	pv-bp15e79d26****
ProductVersionName	string	O nome da versão do produto.	1.0
LastTaskId	string	O ID da última tarefa executada.	task-bp1dmg242c****
LastProvisioningTaskId	string	O ID da última tarefa executada na instância de produto. A tarefa pode ser de um dos seguintes tipos: LaunchProduct: uma tarefa que lança o produto. UpdateProvisionedProduct: uma tarefa que atualiza as informações sobre a instância de produto. TerminateProvisionedProduct: uma tarefa que encerra a instância de produto.	task-bp1dmg242c****
LastSuccessfulProvisioningTaskId	string	O ID da última tarefa executada com sucesso na instância de produto. A tarefa pode ser de um dos seguintes tipos: LaunchProduct: uma tarefa que lança o produto. UpdateProvisionedProduct: uma tarefa que atualiza as informações sobre a instância de produto. TerminateProvisionedProduct: uma tarefa que encerra a instância de produto.	task-bp1dmg242c****
OwnerPrincipalType	string	O tipo da entidade do Resource Access Management (RAM) à qual a instância de produto pertence. Valores válidos: RamUser: um usuário RAM RamRole: uma função RAM	RamUser
OwnerPrincipalId	string	O ID da entidade RAM à qual a instância de produto pertence.	24477111603637****
Status	string	O estado da instância de produto. Valores válidos: Available: a instância de produto estava disponível. UnderChange: as informações sobre a instância de produto estavam sendo alteradas. Error: ocorreu uma exceção na instância de produto.	Available
StatusMessage	string	A mensagem retornada para o status da instância de produto. Nota Este parâmetro é retornado apenas quando Error é retornado para o parâmetro Status.	Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	A hora em que a instância de produto foi criada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-05-23T09:46:27Z
PortfolioId	string	O ID do portfólio de produtos.	port-bp1yt7582g****
StackId	string	O ID da stack do Resource Orchestration Service (ROS).	137e31df-3754-40b4-be2f-c793ad84****
StackRegionId	string	O ID da região à qual a stack do ROS pertence.	cn-hangzhou
ProvisionedProductType	string	O tipo da instância de produto. O valor é fixo como RosStack, que indica uma stack do ROS.	RosStack
RequestId	string	O ID da solicitação.	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TotalCount	integer	O número total de entradas retornadas.	2
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "ProvisionedProductDetails": [
    {
      "ProvisionedProductName": "DEMO-ECS-Instance",
      "ProvisionedProductId": "pp-bp1ddg1n2a****",
      "ProvisionedProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-Create ECS",
      "ProductVersionId": "pv-bp15e79d26****",
      "ProductVersionName": "1.0",
      "LastTaskId": "task-bp1dmg242c****",
      "LastProvisioningTaskId": "task-bp1dmg242c****",
      "LastSuccessfulProvisioningTaskId": "task-bp1dmg242c****",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****",
      "Status": "Available",
      "StatusMessage": "Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-05-23T09:46:27Z",
      "PortfolioId": "port-bp1yt7582g****",
      "StackId": "137e31df-3754-40b4-be2f-c793ad84****",
      "StackRegionId": "cn-hangzhou",
      "ProvisionedProductType": "RosStack"
    }
  ],
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError	A system error occurred.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.