GetProvisionedProductPlan - 查询计划信息 - 服务目录

查询计划信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

servicecatalog:GetProvisionedProductPlan

get

*ProvisionedProduct

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

servicecatalog:UserLevel
servicecatalog:ApprovalActor

无

请求参数

名称	类型	必填	描述	示例值
PlanId	string	是	计划 ID。	plan-bp1jvmdk2k****

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
PlanDetail	object	计划详情。
PlanId	string	计划 ID。	plan-bp1jvmdk2k****
PlanName	string	计划名称。	DEMO-ECS实例
PlanType	string	计划类型。取值为 Ros，表示阿里云资源编排服务（ROS）。	Ros
PortfolioId	string	产品组合 ID。	port-bp1yt7582g****
ProductId	string	产品 ID。	prod-bp18r7q127****
ProductVersionId	string	产品版本 ID。	pv-bp15e79d26****
ProvisionedProductId	string	实例 ID。	pp-bp1ddg1n2a****
ProvisionedProductName	string	实例名称。	DEMO-ECS实例
Parameters	array<object>	用户输入的模板参数。
	object
ParameterKey	string	模板中定义的参数名称。	instance_type
ParameterValue	string	用户输入的模板参数值。	ecs.s6-c1m1.small
StackId	string	阿里云资源编排服务（ROS）资源栈 ID。	137e31df-3754-40b4-be2f-c793ad84****
StackRegionId	string	阿里云资源编排服务（ROS）资源栈所属的地域 ID。	cn-hangzhou
Status	string	计划状态。取值： PreviewInProgress：预检中。 PreviewSuccess：预检成功。 PreviewFailed：预检失败。 ApplicationInProgress：审批中。 ApplicationApproved：审批通过。 ApplicationRejected：审批被拒绝。 ExecuteInProgress：执行中。 ExecuteSuccess：执行成功。 ExecuteFailed：执行失败。 Canceled：已取消。	PreviewSuccess
StatusMessage	string	计划状态信息。说明仅在计划状态为 PreviewFailed 或 ExecuteFailed 时，返回该参数。	Create stack failed: Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	计划创建时间。按照 ISO8601 标准表示，使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ssZ。	2022-05-23T09:46:27Z
UpdateTime	string	计划最后更新时间。按照 ISO8601 标准表示，使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ssZ。	2022-05-23T09:47:29Z
Tags	array<object>	用户自定义标签列表。
	object
Key	string	用户自定义标签键。	k1
Value	string	用户自定义标签值。	v1
OperationType	string	计划操作类型。取值： LaunchProduct：启动产品。 UpdateProvisionedProduct：更新实例。 TerminateProvisionedProduct：终止实例。	LaunchProduct
Description	string	计划描述。	创建ECS。
AssignedApprovers	array<object>	计划审批人列表。
	object
PrincipalType	string	计划审批人的 RAM 实体类型。取值： RamUser：RAM 用户。 RamRole：RAM 角色。	RamUser
PrincipalName	string	计划审批人的 RAM 实体名称。	approver
OwnerPrincipalType	string	计划归属人的 RAM 实体类型。取值： RamUser：RAM 用户。 RamRole：RAM 角色。	RamUser
OwnerPrincipalId	string	计划归属人的 RAM 实体 ID。	27740196382623****
ApprovalDetail	object	计划审批详情。
OperationRecords	array<object>	操作记录。
	array<object>
Operator	object	已对计划进行操作的 RAM 实体。
PrincipalType	string	RAM 实体类型。取值： RamUser：RAM 用户。 RamRole：RAM 角色。	RamUser
PrincipalId	string	RAM 实体 ID。	277401963826235***
PrincipalName	string	操作人的 RAM 实体名称。	approver
Comment	string	操作人的审批附加意见。	同意。
CreateTime	string	操作时间。	2022-03-22T05:56:14Z
ApprovalAction	string	操作人对计划进行的操作类型。取值： Submit：提交计划。 Cancel：取消计划。 Approve：审批通过。 Reject：审批拒绝。	Approve
TodoTaskActivities	array<object>	计划正在执行的操作。
	array<object>
ActivityName	string	计划正在执行的操作名。	ApproverNode-1
Tasks	array<object>	委派任务列表。
	array<object>
Operator	object	可对计划进行操作的 RAM 实体。
PrincipalType	string	RAM 实体类型。取值： RamUser：RAM 用户。 RamRole：RAM 角色。	RamUser
PrincipalName	string	RAM 实体名称。	approver
OwnerPrincipalName	string	计划归属人的 RAM 实体名称。	endUser
Uid	string	计划归属人的云账号 ID。	146611588617****
ProductDetail	object	计划产品详情。
ProductArn	string	产品 ARN。	acs:servicecatalog:cn-hangzhou:146611588617**:product/prod-bp18r7q127**
Description	string	产品描述。	这是一个产品描述
CreateTime	string	创建时间。按照 ISO8601 标准表示，使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ssZ。	2022-04-12T06:10:37Z
ProductId	string	产品 ID。	prod-bp18r7q127****
ProductName	string	产品名称。	DEMO-创建ECS
ProviderName	string	产品提供者。	IT团队
ProductType	string	产品类型。取值为 Ros，表示阿里云资源编排服务（ROS）。	Ros
ResourceChanges	array<object>	计划资源变更列表。
	object
LogicalResourceId	string	资源逻辑 ID。	instance
PhysicalResourceId	string	资源物理 ID。说明当 Action 为 Modify 或 Remove 时，返回本参数。	i-bp13lmam3qd9q6il****
Replacement	string	模板是否为替换更新。取值： True：替换更新。 False：修改更新。 Conditional：可能是替换更新，模板运行时才能确定。说明当 Action 为 Modify 时，返回本参数。	True
ResourceType	string	资源类型。	alicloud_instance
Action	string	资源行为。取值： Add：增加资源。 Modify：修改资源。 Remove：删除资源。 None：无变化。	Add
ProductVersionDetail	object	产品版本详情。
Active	boolean	是否启用。取值： true（默认值）：启用。 false：禁用。	true
Description	string	产品版本描述。	这是一个产品版本描述
CreateTime	string	产品版本创建时间。按照 ISO8601 标准表示，使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ssZ。	2022-04-12T06:10:37Z
Guidance	string	推荐信息。取值： Default（默认值）：无。 Recommended：稳定版。 Latest：最新版。 Deprecated：将废弃。	Default
ProductVersionId	string	产品版本 ID。	pv-bp15e79d26****
ProductVersionName	string	产品版本名称。	1.0.0
ProductId	string	产品版本所属的产品 ID。	prod-bp18r7q127****
TemplateUrl	string	模板的 URL 地址。	oss://servicecatalog-cn-hangzhou/146611588617**/terraform/template/tpl-bp1217we23**/template.json
TemplateType	string	模板类型。取值为 RosTerraformTemplate，表示阿里云资源编排服务（ROS）支持的 Terraform 模板。	RosTerraformTemplate

示例

正常返回示例

JSON格式

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "PlanDetail": {
    "PlanId": "plan-bp1jvmdk2k****",
    "PlanName": "DEMO-ECS实例",
    "PlanType": "Ros",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-ECS实例",
    "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": "创建ECS。",
    "AssignedApprovers": [
      {
        "PrincipalType": "RamUser",
        "PrincipalName": "approver"
      }
    ],
    "OwnerPrincipalType": "RamUser",
    "OwnerPrincipalId": "27740196382623****",
    "ApprovalDetail": {
      "OperationRecords": [
        {
          "Operator": {
            "PrincipalType": "RamUser",
            "PrincipalId": "277401963826235***\n",
            "PrincipalName": "approver"
          },
          "Comment": "同意。",
          "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": "这是一个产品描述",
    "CreateTime": "2022-04-12T06:10:37Z",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-创建ECS",
    "ProviderName": "IT团队",
    "ProductType": "Ros"
  },
  "ResourceChanges": [
    {
      "LogicalResourceId": "instance",
      "PhysicalResourceId": "i-bp13lmam3qd9q6il****",
      "Replacement": "True",
      "ResourceType": "alicloud_instance\n",
      "Action": "Add"
    }
  ],
  "ProductVersionDetail": {
    "Active": true,
    "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"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	A system error occurred.	内部错误。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。