全部产品
Search
文档中心

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

更新时间:May 21, 2024

查询计划信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
servicecatalog:GetProvisionedProductPlanRead
  • ProvisionedProduct
    acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/{#ProvisionedProductId}
  • servicecatalog:UserLevel
  • servicecatalog:ApprovalActor

请求参数

名称类型必填描述示例值
PlanIdstring

计划 ID。

plan-bp1jvmdk2k****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
PlanDetailobject

计划详情。

PlanIdstring

计划 ID。

plan-bp1jvmdk2k****
PlanNamestring

计划名称。

DEMO-ECS实例
PlanTypestring

计划类型。

取值为 Ros,表示阿里云资源编排服务(ROS)。

Ros
PortfolioIdstring

产品组合 ID。

port-bp1yt7582g****
ProductIdstring

产品 ID。

prod-bp18r7q127****
ProductVersionIdstring

产品版本 ID。

pv-bp15e79d26****
ProvisionedProductIdstring

实例 ID。

pp-bp1ddg1n2a****
ProvisionedProductNamestring

实例名称。

DEMO-ECS实例
Parametersobject []

用户输入的模板参数。

ParameterKeystring

模板中定义的参数名称。

instance_type
ParameterValuestring

用户输入的模板参数值。

ecs.s6-c1m1.small
StackIdstring

阿里云资源编排服务(ROS)资源栈 ID。

137e31df-3754-40b4-be2f-c793ad84****
StackRegionIdstring

阿里云资源编排服务(ROS)资源栈所属的地域 ID。

cn-hangzhou
Statusstring

计划状态。取值:

  • PreviewInProgress:预检中。
  • PreviewSuccess:预检成功。
  • PreviewFailed:预检失败。
  • ApplicationInProgress:审批中。
  • ApplicationApproved:审批通过。
  • ApplicationRejected:审批被拒绝。
  • ExecuteInProgress:执行中。
  • ExecuteSuccess:执行成功。
  • ExecuteFailed:执行失败。
  • Canceled:已取消。
PreviewSuccess
StatusMessagestring

计划状态信息。

说明 仅在计划状态为 PreviewFailed 或 ExecuteFailed 时,返回该参数。
Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...
CreateTimestring

计划创建时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-05-23T09:46:27Z
UpdateTimestring

计划最后更新时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-05-23T09:47:29Z
Tagsobject []

用户自定义标签列表。

Keystring

用户自定义标签键。

k1
Valuestring

用户自定义标签值。

v1
OperationTypestring

计划操作类型。取值:

  • LaunchProduct:启动产品。
  • UpdateProvisionedProduct:更新实例。
  • TerminateProvisionedProduct:终止实例。
LaunchProduct
Descriptionstring

计划描述。

创建ECS。
AssignedApproversobject []

计划审批人列表。

PrincipalTypestring

计划审批人的 RAM 实体类型。取值:

  • RamUser:RAM 用户。
  • RamRole:RAM 角色。
RamUser
PrincipalNamestring

计划审批人的 RAM 实体名称。

approver
OwnerPrincipalTypestring

计划归属人的 RAM 实体类型。取值:

  • RamUser:RAM 用户。
  • RamRole:RAM 角色。
RamUser
OwnerPrincipalIdstring

计划归属人的 RAM 实体 ID。

27740196382623****
ApprovalDetailobject

计划审批详情。

OperationRecordsobject []

操作记录。

Operatorobject

已对计划进行操作的 RAM 实体。

PrincipalTypestring

RAM 实体类型。取值:

  • RamUser:RAM 用户。
  • RamRole:RAM 角色。
RamUser
PrincipalIdstring

RAM 实体 ID。

277401963826235***
PrincipalNamestring

操作人的 RAM 实体名称。

approver
Commentstring

操作人的审批附加意见。

同意。
CreateTimestring

操作时间。

2022-03-22T05:56:14Z
ApprovalActionstring

操作人对计划进行的操作类型。取值:

  • Submit:提交计划。
  • Cancel:取消计划。
  • Approve:审批通过。
  • Reject:审批拒绝。
Approve
TodoTaskActivitiesobject []

计划正在执行的操作。

ActivityNamestring

计划正在执行的操作名。

ApproverNode-1
Tasksobject []

委派任务列表。

Operatorobject

可对计划进行操作的 RAM 实体。

PrincipalTypestring

RAM 实体类型。取值:

  • RamUser:RAM 用户。
  • RamRole:RAM 角色。
RamUser
PrincipalNamestring

RAM 实体名称。

approver
OwnerPrincipalNamestring

计划归属人的 RAM 实体名称。

endUser
Uidstring

计划归属人的云账号 ID。

146611588617****
ProductDetailobject

计划产品详情。

ProductArnstring

产品 ARN。

acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****
Descriptionstring

产品描述。

这是一个产品描述
CreateTimestring

创建时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-04-12T06:10:37Z
ProductIdstring

产品 ID。

prod-bp18r7q127****
ProductNamestring

产品名称。

DEMO-创建ECS
ProviderNamestring

产品提供者。

IT团队
ProductTypestring

产品类型。

取值为 Ros,表示阿里云资源编排服务(ROS)。

Ros
ResourceChangesobject []

计划资源变更列表。

LogicalResourceIdstring

资源逻辑 ID。

instance
PhysicalResourceIdstring

资源物理 ID。

说明 当 Action 为 Modify 或 Remove 时,返回本参数。
i-bp13lmam3qd9q6il****
Replacementstring

模板是否为替换更新。取值:

  • True:替换更新。
  • False:修改更新。
  • Conditional:可能是替换更新,模板运行时才能确定。
说明 当 Action 为 Modify 时,返回本参数。
True
ResourceTypestring

资源类型。

alicloud_instance
Actionstring

资源行为。取值:

  • Add:增加资源。
  • Modify:修改资源。
  • Remove:删除资源。
  • None:无变化。
Add
ProductVersionDetailobject

产品版本详情。

Activeboolean

是否启用。取值:

  • true(默认值):启用。
  • false:禁用。
true
Descriptionstring

产品版本描述。

这是一个产品版本描述
CreateTimestring

产品版本创建时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-04-12T06:10:37Z
Guidancestring

推荐信息。取值:

  • Default(默认值):无。
  • Recommended:稳定版。
  • Latest:最新版。
  • Deprecated:将废弃。
Default
ProductVersionIdstring

产品版本 ID。

pv-bp15e79d26****
ProductVersionNamestring

产品版本名称。

1.0.0
ProductIdstring

产品版本所属的产品 ID。

prod-bp18r7q127****
TemplateUrlstring

模板的 URL 地址。

oss://servicecatalog-cn-hangzhou/146611588617****/terraform/template/tpl-bp1217we23****/template.json
TemplateTypestring

模板类型。

取值为 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错误码错误信息描述
500InternalErrorA system error occurred.内部错误。

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