GetTask を使用したタスク情報のクエリ - 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:GetTask

get

*ProvisionedProduct

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

servicecatalog:UserLevel
servicecatalog:ApprovalActor

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	必須	タスクの ID です。	task-bp1dmg242c****

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーターです。
RequestId	string	リクエストの ID です。	0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TaskDetail	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	プロダクトインスタンスの名前です。	DEMO-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 Terraform コマンドの詳細については、「Basic CLI Features」をご参照ください。	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	タスクの状態に対応するメッセージです。説明このパラメーターは、Status パラメーターの値が Failed の場合のみ返されます。	Resource CREATE failed: terraform stack sc-146611588617**-pp-bp1ddg1n2a** failure...
CreateTime	string	タスクが作成された時刻です。時刻は ISO 8601 標準（yyyy-MM-ddTHH:mm:ssZ）に従い、協定世界時 (UTC) で表示されます。	2022-05-23T09:46:27Z
UpdateTime	string	タスクが最後に更新された時刻です。時刻は ISO 8601 標準（yyyy-MM-ddTHH:mm:ssZ）に従い、協定世界時 (UTC) で表示されます。	2022-05-23T09:47:29Z
TaskTags	array<object>	カスタムタグです。
	object
Key	string	カスタムタグキーです。タグキーは最大 128 文字まで使用でき、`http://` および `https://` を含めることはできません。また、`acs:` または `aliyun` で始めてはいけません。	k1
Value	string	カスタムタグ値です。値は 1～128 文字の長さである必要があります。`acs:` で始めてはならず、`http://` および `https://` を含めることはできません。	v1

例

成功レスポンス

JSONJSON

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TaskDetail": {
    "TaskId": "task-bp1dmg242c****",
    "TaskType": "LaunchProduct",
    "PortfolioId": "port-bp1yt7582g****",
    "ProductId": "prod-bp18r7q127****",
    "ProductName": "DEMO-创建ECS",
    "ProductVersionId": "pv-bp15e79d26****",
    "ProductVersionName": "1.0",
    "ProvisionedProductId": "pp-bp1ddg1n2a****",
    "ProvisionedProductName": "DEMO-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-23T09:47:29Z",
    "TaskTags": [
      {
        "Key": "k1",
        "Value": "v1"
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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