すべてのプロダクト
Search

このプロダクト

    Service Catalog:GetProvisionedProductPlan

    ドキュメントセンター

    Service Catalog:GetProvisionedProductPlan

    最終更新日:Mar 13, 2026

    プランの詳細を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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 に固定されており、Resource Orchestration Service (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

    状態に対して返されるメッセージ。

    説明

    このパラメーターは、Status に PreviewFailed または ExecuteFailed が返された場合にのみ返されます。

    Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...
    CreateTime

    string

    プランが作成された時間。

    時間は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時間は協定世界時 (UTC) で表示されます。

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

    string

    タスクが最後に変更された時間。

    時間は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時間は協定世界時 (UTC) で表示されます。

    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

    プラン承認者の Resource Access Management (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

    プランが属する Alibaba Cloud アカウントの ID。

    146611588617****
    ProductDetail

    object

    プロダクトの詳細。

    ProductArn

    string

    プロダクトの Alibaba Cloud リソースネーム (ARN)。

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

    string

    プロダクトの説明。

    这是一个产品描述
    CreateTime

    string

    作成時間。

    時間は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時間は協定世界時 (UTC) で表示されます。

    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

    製品バージョンが作成された時間。

    時間は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時間は協定世界時 (UTC) で表示されます。

    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

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError A system error occurred.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。