ListTasks を使用したタスクリストのクエリ - Service Catalog

タスクの一覧を照会します。

今すぐお試しください

この 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:ListTasks

get

*ProvisionedProduct

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

servicecatalog:UserLevel
servicecatalog:ApprovalActor

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SortBy	string	任意	ソート対象のフィールドです。値は `CreateTime` を指定します。これは、タスクが作成された時刻を示します。	CreateTime
SortOrder	string	任意	ソート順です。有効な値は以下のとおりです。 Asc：昇順。 Desc：降順。	Desc
PageNumber	integer	任意	ページ番号です。正の整数を指定する必要があります。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりの表示件数です。有効な値は 1～100 です。デフォルト値は 10 です。	10
ProvisionedProductId	string	必須	インスタンス ID です。	pp-bp1ddg1n2a****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
TaskDetails	array<object>	タスクの一覧です。
	array<object>	タスクの詳細です。
TaskId	string	タスク ID です。	task-bp1dmg242c****
TaskType	string	タスクの種類です。有効な値は以下のとおりです。 `LaunchProduct`：インスタンスの起動。 `UpdateProvisionedProduct`：インスタンスの更新。 `TerminateProvisionedProduct`：インスタンスの終了。	LaunchProduct
PortfolioId	string	ポートフォリオ ID です。	port-bp1yt7582g****
ProductId	string	プロダクト ID です。	prod-bp18r7q127****
ProductName	string	プロダクト名です。	DEMO-ECS
ProductVersionId	string	プロダクトバージョン ID です。	pv-bp15e79d26****
ProductVersionName	string	プロダクトバージョン名です。	1.0
ProvisionedProductId	string	インスタンス ID です。	pp-bp1ddg1n2a****
ProvisionedProductName	string	インスタンス名です。	Test-ECS
Parameters	array<object>	ユーザーが入力したテンプレートパラメーターです。
	object
ParameterKey	string	テンプレートで定義されたパラメーター名です。	instance_type
ParameterValue	string	ユーザーが入力したテンプレートパラメーターの値です。	ecs.s6-c1m1.small
Outputs	array<object>	テンプレートの出力です。
	object
OutputKey	string	テンプレートで定義された出力キーです。	instance_id
OutputValue	string	テンプレートで定義された出力値です。	i-xxxxxx
Description	string	テンプレートで定義された出力の説明です。	The ECS instance ID.
Log	object	インスタンスの出力ログです。
TerraformLogs	array<object>	Terraform の出力ログです。
	object
Command	string	実行された Terraform コマンドの名称です。有効な値は以下のとおりです。 apply plan destroy version コマンドの詳細については、「Command」をご参照ください。	apply
Stream	string	出力ストリームです。有効な値は以下のとおりです。 stdout：標準出力。 stderr：標準エラー出力。	stdout
Content	string	出力ストリームでコマンドから返された内容です。	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
Status	string	タスクのステータスです。有効な値は以下のとおりです。 Succeeded InProgress Failed	Succeeded
StatusMessage	string	タスクのステータスメッセージです。説明このパラメーターは、タスクが失敗した場合にのみ返されます。	Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	タスクが作成された時刻です。時刻は協定世界時 (UTC) で表示され、ISO 8601 標準に従います。形式は YYYY-MM-DDThh:mm:ssZ です。	2022-05-23T09:46:27Z
UpdateTime	string	タスクが最後に更新された時刻です。時刻は協定世界時 (UTC) で表示され、ISO 8601 標準に従います。形式は YYYY-MM-DDThh:mm:ssZ です。	2022-05-26T03:28:45Z
RequestId	string	リクエスト ID です。	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TotalCount	integer	合計件数です。	2
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりの表示件数です。	10

例

成功レスポンス

JSONJSON

{
  "TaskDetails": [
    {
      "TaskId": "task-bp1dmg242c****",
      "TaskType": "LaunchProduct",
      "PortfolioId": "port-bp1yt7582g****",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-ECS",
      "ProductVersionId": "pv-bp15e79d26****",
      "ProductVersionName": "1.0",
      "ProvisionedProductId": "pp-bp1ddg1n2a****",
      "ProvisionedProductName": "Test-ECS",
      "Parameters": [
        {
          "ParameterKey": "instance_type",
          "ParameterValue": "ecs.s6-c1m1.small"
        }
      ],
      "Outputs": [
        {
          "OutputKey": "instance_id",
          "OutputValue": "i-xxxxxx",
          "Description": "The ECS instance ID."
        }
      ],
      "Log": {
        "TerraformLogs": [
          {
            "Command": "apply",
            "Stream": "stdout",
            "Content": "Apply complete! Resources: 42 added, 0 changed, 0 destroyed."
          }
        ]
      },
      "Status": "Succeeded",
      "StatusMessage": "Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-05-23T09:46:27Z",
      "UpdateTime": "2022-05-26T03:28:45Z"
    }
  ],
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	A system error occurred.

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

変更履歴

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