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

Consulta uma lista de planos. Você pode consultar planos a partir da dimensão do usuário final ou da dimensão de revisã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

servicecatalog:ListProvisionedProductPlans

list

*All Resource

*

servicecatalog:UserLevel
servicecatalog:ApprovalActor

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Filters	array<object>	Não	Uma matriz que consiste em condições de filtro.
	object	Não
Key	string	Não	O nome da condição de filtro. Valores válidos: ProvisionedProductPlanName: realiza correspondências exatas pelo nome do plano. Os nomes dos planos não diferenciam maiúsculas de minúsculas. ProvisionedProductPlanApprover: realiza correspondências exatas pelo revisor. Você deve especificar um revisor no formato RamUser/RamRole:. Você pode especificar vários revisores. ProvisionedProductPlanApproverName: realiza correspondências pelo nome do revisor. Você deve especificar o nome da entidade do Resource Access Management (RAM) do revisor. Você pode especificar vários nomes de revisores. ProvisionedProductPlanStatus: realiza correspondências pelo status do plano. Você deve especificar o estado do plano. Você pode especificar vários estados. ProvisionedProductPlanOwnerUid: realiza correspondências exatas pelo ID da conta Alibaba Cloud à qual um plano pertence. FullTextSearch: realiza pesquisas difusas de texto completo pelo nome do plano.	FullTextSearch
Value	string	Não	O valor da condição de filtro.	ECS
SortBy	string	Não	As informações com base nas quais você deseja classificar os resultados da consulta. Defina o valor como CreateTime, que especifica a hora de criação dos planos.	CreateTime
SortOrder	string	Não	A ordem na qual você deseja classificar os resultados da consulta. Valores válidos: Asc: a ordem crescente. Desc (padrão): a ordem decrescente. Valores válidos: Asc : Asc. Desc : Desc.	Desc
PageNumber	integer	Não	O número da página a ser retornada. As páginas começam na 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 mínimo: 1. Valor padrão: 10.	10
AccessLevelFilter	string	Não	O filtro de acesso. Valores válidos: User (padrão): consulta os planos criados pelo solicitante atual. Account: consulta os planos que pertencem à conta atual da Alibaba Cloud. ResourceDirectory: consulta os planos que pertencem ao diretório de recursos atual.	User
ApprovalFilter	string	Não	O filtro de acesso da dimensão de revisão. Valores válidos: ReceivedRequests: consulta planos que estão pendentes de revisão. ApprovalHistory: consulta o histórico de revisões. AccountRequests: consulta todos os planos que pertencem à conta atual da Alibaba Cloud. AccountRequests: consulta todos os planos que pertencem à conta atual da Alibaba Cloud.	ReceivedRequests
ProvisionedProductId	string	Não	O ID da instância do produto.	pp-bp1ddg1n2a****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	0FEEF92D-4052-5202-87D0-3D8EC16F****
PlanDetails	array<object>	Uma matriz que consiste em planos.
	array<object>
PlanId	string	O ID do plano.	plan-bp18mmdh2u****
PlanName	string	O nome do plano.	DEMO- create ECS-637****
PlanType	string	O tipo do plano. O valor é fixo como Ros, que indica o Resource Orchestration Service (ROS).	Ros
PortfolioId	string	O ID do portfólio de produtos.	port-bp1438kf2j****
ProductId	string	O ID do produto.	prod-bp1rtrnh2c****
ProductVersionId	string	O ID da versão do produto.	pv-bp19udk22v****
ProvisionedProductId	string	O ID da instância do produto.	pp-bp1c35162d****
Parameters	array<object>	Uma matriz que consiste nos parâmetros do modelo.
	object
ParameterKey	string	The name of the parameter in the template.	role_name
ParameterValue	string	The value of the parameter in the template.	Test-8
ProvisionedProductName	string	O nome da instância do produto.	rds-MYSQL-875****
StackId	string	O ID da pilha do ROS.	2599090a-309e-4306-b989-17ba66a9****
StackRegionId	string	O ID da região à qual a pilha do ROS pertence.	cn-hangzhou
Status	string	O estado do plano. Valores válidos: PreviewInProgress: O plano está sendo pré-verificado. PreviewSuccess: A pré-verificação foi bem-sucedida. PreviewFailed: A pré-verificação falhou. ApplicationInProgress: O plano está sendo revisado. ApplicationApproved: O plano foi aprovado. ApplicationRejected: A aprovação foi rejeitada. ExecuteInProgress: O plano está sendo executado. ExecuteSuccess: O plano foi executado. ExecuteFailed: A execução do plano falhou. Canceled: O plano foi cancelado.	PreviewSuccess
StatusMessage	string	A mensagem retornada para o estado. Nota Este parâmetro é retornado apenas quando PreviewFailed ou ExecuteFailed é retornado para o parâmetro Status.	Create stack failed: Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	A hora em que o plano foi criado. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-09-13T02:01:22Z
UpdateTime	string	A última vez em que a tarefa foi modificada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-07-18T06:02:35.075Z
Tags	array<object>	Uma matriz que consiste em tags personalizadas.
	object
Key	string	The key of the custom tag.	k1
Value	string	The value of the custom tag.	v1
OperationType	string	A finalidade do plano. Valores válidos: LaunchProduct: inicia o produto. Este é o valor padrão. UpdateProvisionedProduct: atualiza as informações sobre a instância do produto. TerminateProvisionedProduct: encerra a instância do produto.	LaunchProduct
AssignedApprovers	array<object>	Uma matriz que consiste em revisores.
	object
PrincipalType	string	The type of the RAM entity of the reviewer. Valid values: RamUser: a RAM user RamRole: a RAM role	RamUser
PrincipalName	string	The RAM entity name of the reviewer.	endUser
ProductName	string	O nome do produto.	Create ECS
Description	string	A descrição do plano.	Dev team usage
OwnerPrincipalType	string	O tipo de entidade RAM à qual o plano pertence. Valores válidos: RamUser: um usuário RAM RamRole: uma função RAM	RamUser
OwnerPrincipalId	string	O ID da entidade RAM à qual o plano pertence.	24477111603637****
OwnerPrincipalName	string	O nome da entidade RAM à qual o plano pertence.	enduser
Uid	string	O ID da conta Alibaba Cloud à qual o plano pertence.	146611588617****
TotalCount	integer	O número total de entradas retornadas.	16
PageNumber	integer	O número da página retornada. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	O número de entradas retornadas por página. Valores válidos: 1 a 100. Valor mínimo: 1. Valor padrão: 10.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F****",
  "PlanDetails": [
    {
      "PlanId": "plan-bp18mmdh2u****",
      "PlanName": "DEMO- create ECS-637****",
      "PlanType": "Ros",
      "PortfolioId": "port-bp1438kf2j****",
      "ProductId": "prod-bp1rtrnh2c****",
      "ProductVersionId": "pv-bp19udk22v****",
      "ProvisionedProductId": "pp-bp1c35162d****",
      "Parameters": [
        {
          "ParameterKey": "role_name",
          "ParameterValue": "Test-8"
        }
      ],
      "ProvisionedProductName": "rds-MYSQL-875****",
      "StackId": "2599090a-309e-4306-b989-17ba66a9****",
      "StackRegionId": "cn-hangzhou",
      "Status": "PreviewSuccess",
      "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-09-13T02:01:22Z",
      "UpdateTime": "2022-07-18T06:02:35.075Z",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ],
      "OperationType": "LaunchProduct",
      "AssignedApprovers": [
        {
          "PrincipalType": "RamUser",
          "PrincipalName": "endUser"
        }
      ],
      "ProductName": "Create ECS",
      "Description": "Dev team usage",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****\n",
      "OwnerPrincipalName": "enduser",
      "Uid": "146611588617****"
    }
  ],
  "TotalCount": 16,
  "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.