すべてのプロダクト
Search
ドキュメントセンター

Service Catalog:ListProvisionedProductPlans

最終更新日:Feb 10, 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:ListProvisionedProductPlans

list

*All Resource

*

  • servicecatalog:UserLevel
  • servicecatalog:ApprovalActor
なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Filters

array<object>

任意

フィルター条件で構成される配列です。

object

任意

Key

string

任意

フィルター条件の名前。有効な値:

  • ProvisionedProductPlanName:プラン名による完全一致検索を実行します。プラン名では大文字と小文字は区別されません。

  • ProvisionedProductPlanApprover:審査者による完全一致検索を実行します。審査者は RamUser/RamRole:<審査者の名前> の形式で指定する必要があります。複数の審査者を指定できます。

  • ProvisionedProductPlanApproverName:審査者名で検索します。審査者の Resource Access Management (RAM) エンティティ名を指定する必要があります。複数の審査者名を指定できます。

  • ProvisionedProductPlanStatus:プランのステータスで検索します。プランの状態を指定する必要があります。複数の状態を指定できます。

  • ProvisionedProductPlanOwnerUid:プランが属する Alibaba Cloud アカウントの ID による完全一致検索を実行します。

  • FullTextSearch:プラン名によるあいまいな全文検索を実行します。

FullTextSearch

Value

string

任意

フィルター条件の値です。

ECS

SortBy

string

任意

クエリ結果のソート基準となる情報を指定します。

値を CreateTime に設定します。これはプランの作成時間を指定します。

CreateTime

SortOrder

string

任意

クエリ結果のソート順を指定します。有効な値:

  • Asc:昇順

  • Desc (デフォルト):降順

列挙値:

  • Asc :

    Asc

  • Desc :

    Desc

Desc

PageNumber

integer

任意

返すページ番号を指定します。

ページは 1 から始まります。デフォルト値:1。

1

PageSize

integer

任意

各ページに返すエントリ数を指定します。

有効な値:1~100。最小値:1。デフォルト値:10。

10

AccessLevelFilter

string

任意

アクセスフィルター。有効な値:

  • User (デフォルト):現在のリクエスターによって作成されたプランを照会します。

  • Account:現在の Alibaba Cloud アカウントに属するプランを照会します。

  • ResourceDirectory:現在のリソースディレクトリに属するプランを照会します。

User

ApprovalFilter

string

任意

審査ディメンションのアクセスフィルター。有効な値:

  • ReceivedRequests:審査待ちのプランを照会します。

  • ApprovalHistory:審査履歴を照会します。

  • AccountRequests:現在の Alibaba Cloud アカウントに属するすべてのプランを照会します。

  • AccountRequests:現在の Alibaba Cloud アカウントに属するすべてのプランを照会します。

ReceivedRequests

ProvisionedProductId

string

任意

プロダクトインスタンスの ID です。

pp-bp1ddg1n2a****

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

RequestId

string

リクエストの ID です。

0FEEF92D-4052-5202-87D0-3D8EC16F****

PlanDetails

array<object>

プランで構成される配列です。

array<object>

PlanId

string

プランの ID です。

plan-bp18mmdh2u****

PlanName

string

プランの名前です。

DEMO-创建ECS-637****

PlanType

string

プランのタイプです。

値は Ros に固定されており、Resource Orchestration Service (ROS) を示します。

Ros

PortfolioId

string

プロダクトポートフォリオの ID です。

port-bp1438kf2j****

ProductId

string

プロダクトの ID です。

prod-bp1rtrnh2c****

ProductVersionId

string

プロダクトバージョンの ID です。

pv-bp19udk22v****

ProvisionedProductId

string

プロダクトインスタンスの ID です。

pp-bp1c35162d****

Parameters

array<object>

テンプレート内のパラメーターで構成される配列です。

object

ParameterKey

string

テンプレート内のパラメーターの名前です。

role_name

ParameterValue

string

テンプレート内のパラメーターの値です。

Test-8

ProvisionedProductName

string

プロダクトインスタンスの名前です。

rds-MYSQL-875****

StackId

string

ROS スタックの ID です。

2599090a-309e-4306-b989-17ba66a9****

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-09-13T02:01:22Z

UpdateTime

string

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

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

2022-07-18T06:02:35.075Z

Tags

array<object>

カスタムタグで構成される配列です。

object

Key

string

カスタムタグのキーです。

k1

Value

string

カスタムタグの値です。

v1

OperationType

string

プランの目的。有効な値:

  • LaunchProduct:プロダクトを起動します。これがデフォルト値です。

  • UpdateProvisionedProduct:プロダクトインスタンスに関する情報を更新します。

  • TerminateProvisionedProduct:プロダクトインスタンスを終了します。

LaunchProduct

AssignedApprovers

array<object>

審査者で構成される配列です。

object

PrincipalType

string

審査者の RAM エンティティのタイプ。有効な値:

  • RamUser:RAM ユーザー

  • RamRole:RAM ロール

RamUser

PrincipalName

string

審査者の RAM エンティティ名です。

endUser

ProductName

string

プロダクトの名前です。

创建ECS

Description

string

プランの説明です。

开发团队使用

OwnerPrincipalType

string

プランが属する RAM エンティティのタイプ。有効な値:

  • RamUser:RAM ユーザー

  • RamRole:RAM ロール

RamUser

OwnerPrincipalId

string

プランが属する RAM エンティティの ID です。

24477111603637****

OwnerPrincipalName

string

プランが属する RAM エンティティの名前です。

enduser

Uid

string

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

146611588617****

TotalCount

integer

返されたエントリの総数です。

16

PageNumber

integer

返されたページのページ番号です。

ページは 1 から始まります。デフォルト値:1。

1

PageSize

integer

ページごとに返されるエントリの数です。

有効な値:1~100。最小値:1。デフォルト値:10。

10

成功レスポンス

JSONJSON

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F****",
  "PlanDetails": [
    {
      "PlanId": "plan-bp18mmdh2u****",
      "PlanName": "DEMO-创建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": "创建ECS",
      "Description": "开发团队使用",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****\n",
      "OwnerPrincipalName": "enduser",
      "Uid": "146611588617****"
    }
  ],
  "TotalCount": 16,
  "PageNumber": 1,
  "PageSize": 10
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

500 InternalError A system error occurred.

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

変更履歴

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