ListDeploymentJob

更新日時
Copy as MD

作成されたデプロイメントタスクのリストを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-cert:ListDeploymentJob

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

JobType

string

任意

デプロイメントタスクのタイプ。

有効な値:

  • cloud:マルチクラウドデプロイメントタスク。

  • user:クラウドサービスデプロイメントタスク。このタイプのタスクは Elastic Compute Service (ECS) インスタンスをサポートしません。

列挙値:

  • cloud :
  • user :

user

Status

string

任意

デプロイメントタスクのステータス。

有効な値:

  • success

  • pending

  • scheduling

  • processing

  • error

  • editing

列挙値:

  • success :

    success

  • pending :

    pending

  • scheduling :

    scheduling

  • processing :

    processing

  • error :

    error

  • editing :

    editing

pending

CurrentPage

integer

任意

ページ番号。デフォルト値:1。

1

ShowSize

integer

任意

1ページあたりの証明書の数。デフォルト値:50

20

レスポンスフィールド

フィールド

説明

object

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

RequestId

string

リクエスト ID。

12345678-1234-1234-1234-123456789ABC

Total

integer

返されたデプロイメントタスクの総数。

7

CurrentPage

integer

ページ番号。デフォルト値:1。

1

ShowSize

integer

1ページあたりのデプロイメントタスクの数。デフォルト値:50

20

Data

array<object>

リクエストに対して返されたデータ。

object

Id

integer

デプロイメントタスクの ID。この ID を使用して、デプロイメントタスクの詳細とステータスを照会できます。

19975

GmtCreate

string

デプロイメントタスクが作成された時刻。

1624343180000

GmtModified

string

デプロイメントタスクが最後に変更された時刻。

1606482979000

UserId

integer

ユーザーの ID。

1666884372152785

InstanceId

string

デプロイメントタスクのインスタンス ID。

cas-job-user-0gvntn

Name

string

デプロイメントタスクの名前。

job-test

CertType

string

証明書のタイプ。有効な値:

  • upload:アップロードされた証明書

  • buy:購入した証明書

  • free:無料の証明書。中国サイト (aliyun.com) でのみ利用可能です。

upload

ScheduleTime

string

デプロイメントタスクがスケジュールされた時刻。

1606482979000

StartTime

string

デプロイメントタスクの開始時刻。

1606482979000

EndTime

string

デプロイメントタスクの終了時刻。

1606482979000

Status

string

デプロイメントタスクのステータス。有効な値:

  • pending

  • editing

  • scheduling

  • processing

  • error

  • success

scheduling

Del

integer

デプロイメントタスクが削除されたかどうかを示します。有効な値:

  • 0:削除されていません

  • 1:削除済み

1

Rollback

integer

ロールバックワーカーが含まれているかどうかを示します。たとえば、デプロイメントタスクに関連するクラウドサービスがロールバックされた場合、1 が返されます。有効な値:

  • 0:ロールバックワーカーは含まれていません。

  • 1:ロールバックワーカーが含まれています。

1

JobType

string

デプロイメントタスクのタイプ。

  • cloud:マルチクラウドデプロイメントタスク。

  • user:クラウドサービスデプロイメントタスク。このタイプのタスクは ECS インスタンスをサポートしません。

user

CertDomain

string

デプロイメントタスクの証明書にバインドされているドメイン名。

aliyundoc1.com,aliyundoc2.com,aliyundoc3.com

ProductName

string

デプロイメントタスクのリソースに含まれるクラウドサービス。

NLB

成功レスポンス

JSONJSON

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "Total": 7,
  "CurrentPage": 1,
  "ShowSize": 50,
  "Data": [
    {
      "Id": 19975,
      "GmtCreate": "1624343180000",
      "GmtModified": "1606482979000",
      "UserId": 0,
      "InstanceId": "cas-job-user-***",
      "Name": "job-test",
      "CertType": "upload",
      "ScheduleTime": "1606482979000",
      "StartTime": "1606482979000",
      "EndTime": "1606482979000",
      "Status": "scheduling",
      "Del": 1,
      "Rollback": 1,
      "JobType": "user",
      "CertDomain": "aliyundoc1.com,aliyundoc2.com,aliyundoc3.com",
      "ProductName": "NLB"
    }
  ]
}

エラーコード

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

変更履歴

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