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

Consulta um plano de produto provisionado.

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:GetProvisionedProductPlan

get

*ProvisionedProduct

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

servicecatalog:UserLevel
servicecatalog:ApprovalActor

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PlanId	string	Sim	O ID do plano.	plan-bp1jvmdk2k****

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-3D8EC16F81BF
PlanDetail	object	Os detalhes do plano.
PlanId	string	O ID do plano.	plan-bp1jvmdk2k****
PlanName	string	O nome do plano.	DEMO-ECS-Instance
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-bp1yt7582g****
ProductId	string	O ID do produto.	prod-bp18r7q127****
ProductVersionId	string	O ID da versão do produto.	pv-bp15e79d26****
ProvisionedProductId	string	O ID da instância do produto.	pp-bp1ddg1n2a****
ProvisionedProductName	string	O nome da instância do produto.	DEMO-ECS-Instance
Parameters	array<object>	Uma matriz que consiste nos parâmetros do modelo.
	object
ParameterKey	string	The name of the input parameter for the template.	instance_type
ParameterValue	string	The value of the input parameter for the template.	ecs.s6-c1m1.small
StackId	string	O ID da pilha do ROS.	137e31df-3754-40b4-be2f-c793ad84****
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 aprovado. 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 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-05-23T09:46:27Z
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-05-23T09:47:29Z
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. UpdateProvisionedProduct: atualiza as informações sobre a instância do produto. TerminateProvisionedProduct: encerra a instância do produto.	LaunchProduct
Description	string	A descrição do plano.	Create ECS
AssignedApprovers	array<object>	Uma matriz que consiste em aprovadores.
	object
PrincipalType	string	The type of the Resource Access Management (RAM) entity of the plan approver. Valid values: RamUser: a RAM user. RamRole: a RAM role.	RamUser
PrincipalName	string	The name of the RAM entity of the plan approver.	approver
OwnerPrincipalType	string	O tipo de entidade do RAM à qual o plano pertence. Valores válidos: RamUser: um usuário do RAM RamRole: uma função do RAM	RamUser
OwnerPrincipalId	string	O ID da entidade do RAM à qual o plano pertence.	27740196382623****
ApprovalDetail	object	Os detalhes de aprovação do plano.
OperationRecords	array<object>	The operation records.
	array<object>
Operator	object	The RAM entities that have performed operations on the plan.
PrincipalType	string	The type of the RAM entity. Valid values: RamUser: a RAM user. RamRole: a RAM role.	RamUser
PrincipalId	string	The ID of the RAM entity.	277401963826235***
PrincipalName	string	The name RAM entity that servers as the operator.	approver
Comment	string	The approval comment of the operator.	Agree
CreateTime	string	The time when the operation was performed.	2022-03-22T05:56:14Z
ApprovalAction	string	The operation that is performed by the operator on the plan. Valid values: Submit: submits the plan. Cancel: cancels the plan. Approve: approves the plan. reject: rejectes the plan.	Approve
TodoTaskActivities	array<object>	The operations that are being performed by the plan.
	array<object>
ActivityName	string	The name of the operation that is being performed by the plan.	ApproverNode-1
Tasks	array<object>	The tasks that are pending for review.
	array<object>
Operator	object	The RAM entities that can perform operations on the plan.
PrincipalType	string	The type of the RAM entity. Valid values: RamUser: a RAM user. RamRole: a RAM role.	RamUser
PrincipalName	string	The name of the RAM entity.	approver
OwnerPrincipalName	string	O nome da entidade do RAM à qual o plano pertence.	endUser
Uid	string	O ID da conta Alibaba Cloud à qual o plano pertence.	146611588617****
ProductDetail	object	Os detalhes do produto.
ProductArn	string	O Alibaba Cloud Resource Name (ARN) do produto.	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
Description	string	A descrição do produto.	This is a product description.
CreateTime	string	A hora de criação. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-04-12T06:10:37Z
ProductId	string	O ID do produto.	prod-bp18r7q127****
ProductName	string	O nome do produto.	DEMO-Create ECS
ProviderName	string	O provedor do produto.	IT team
ProductType	string	O tipo do produto. O valor é fixo como Ros, que indica o ROS.	Ros
ResourceChanges	array<object>	Uma matriz que consiste nos recursos a serem alterados no plano.
	object
LogicalResourceId	string	O ID lógico do recurso.	instance
PhysicalResourceId	string	O ID físico do recurso. Nota Este parâmetro é retornado se o valor de Action for Modify ou Remove.	i-bp13lmam3qd9q6il****
Replacement	string	Indica se uma atualização de substituição é realizada no modelo. Valores válidos: True: Uma atualização de substituição é realizada no modelo. False: Uma alteração é feita no modelo. Conditional: Uma atualização de substituição pode ser realizada no modelo. Você pode verificar se uma atualização de substituição é realizada quando o modelo está em uso. Nota Este parâmetro é retornado se o valor de Action for Modify.	True
ResourceType	string	O tipo de recurso.	alicloud_instance
Action	string	A ação que é realizada no recurso. Valores válidos: Add Modify Remove None	Add
ProductVersionDetail	object	Os detalhes da versão do produto.
Active	boolean	Indica se a versão do produto está visível para os usuários finais. Valores válidos: true (padrão) false	true
Description	string	A descrição da versão do produto.	This is a product version description.
CreateTime	string	A hora em que a versão do produto foi criada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-04-12T06:10:37Z
Guidance	string	As informações de recomendação. Valores válidos: Default: Nenhuma informação de recomendação é fornecida. Este é o valor padrão. Recommended: a versão recomendada. Latest: a versão mais recente. Deprecated: a versão que está prestes a ser descontinuada.	Default
ProductVersionId	string	O ID da versão do produto.	pv-bp15e79d26****
ProductVersionName	string	O nome da versão do produto.	1.0.0
ProductId	string	O ID do produto ao qual a versão do produto pertence.	prod-bp18r7q127****
TemplateUrl	string	A URL do modelo.	oss://servicecatalog-cn-hangzhou/146611588617**/terraform/template/tpl-bp1217we23**/template.json
TemplateType	string	O tipo do modelo. O valor é fixo como RosTerraformTemplate, que indica que o modelo do Terraform é suportado pelo ROS.	RosTerraformTemplate

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "PlanDetail": {
    "PlanId": "plan-bp1jvmdk2k****",
    "PlanName": "DEMO-ECS-Instance",
    "PlanType": "Ros",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS-Instance",
    "Parameters": [
      {
        "ParameterKey": "instance_type",
        "ParameterValue": "ecs.s6-c1m1.small"
      }
    ],
    "StackId": "137e31df-3754-40b4-be2f-c793ad84****",
    "StackRegionId": "cn-hangzhou",
    "Status": "PreviewSuccess",
    "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
    "CreateTime": "2022-05-23T09:46:27Z",
    "UpdateTime": "2022-05-23T09:47:29Z",
    "Tags": [
      {
        "Key": "k1",
        "Value": "v1"
      }
    ],
    "OperationType": "LaunchProduct",
    "Description": "Create ECS",
    "AssignedApprovers": [
      {
        "PrincipalType": "RamUser",
        "PrincipalName": "approver"
      }
    ],
    "OwnerPrincipalType": "RamUser",
    "OwnerPrincipalId": "27740196382623****",
    "ApprovalDetail": {
      "OperationRecords": [
        {
          "Operator": {
            "PrincipalType": "RamUser",
            "PrincipalId": "277401963826235***\n",
            "PrincipalName": "approver"
          },
          "Comment": "Agree",
          "CreateTime": "2022-03-22T05:56:14Z",
          "ApprovalAction": "Approve"
        }
      ],
      "TodoTaskActivities": [
        {
          "ActivityName": "ApproverNode-1",
          "Tasks": [
            {
              "Operator": {
                "PrincipalType": "RamUser",
                "PrincipalName": "approver"
              }
            }
          ]
        }
      ]
    },
    "OwnerPrincipalName": "endUser",
    "Uid": "146611588617****"
  },
  "ProductDetail": {
    "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
    "Description": "This is a product description.",
    "CreateTime": "2022-04-12T06:10:37Z",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-Create ECS",
    "ProviderName": "IT team",
    "ProductType": "Ros"
  },
  "ResourceChanges": [
    {
      "LogicalResourceId": "instance",
      "PhysicalResourceId": "i-bp13lmam3qd9q6il****",
      "Replacement": "True",
      "ResourceType": "alicloud_instance\n",
      "Action": "Add"
    }
  ],
  "ProductVersionDetail": {
    "Active": true,
    "Description": "This is a product version description.",
    "CreateTime": "2022-04-12T06:10:37Z",
    "Guidance": "Default",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0.0",
    "ProductId": "prod-bp18r7q127****",
    "TemplateUrl": "oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json",
    "TemplateType": "RosTerraformTemplate"
  }
}

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.