ListLiveSnapshotJobs - Intelligent Media Services - Alibaba Cloud ドキュメントセンター

ライブスナップショットタスクのリストをページネーション付きで照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ice:ListLiveSnapshotJobs

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	string	任意	クエリの開始時刻。yyyy-MM-ddTHH:mm:ssZ フォーマットで協定世界時 (UTC) 時間を指定します。デフォルト値: 現在時刻の 7 日前。 StartTime と EndTime の間隔は 30 日を超えることはできません。	2022-02-02T00:00:00Z
EndTime	string	任意	クエリの終了時刻。yyyy-MM-ddTHH:mm:ssZ フォーマットで協定世界時 (UTC) 時間を指定します。デフォルト値: StartTime + 7 日。 StartTime と EndTime の間隔は 30 日を超えることはできません。	2022-02-02T23:59:59Z
SearchKeyWord	string	任意	検索キーワード。タスク ID または名前で検索できます。名前ではあいまい一致がサポートされています。最大長: 128。	**a046-263c-3560-978a-fb287782**
Status	string	任意	タスクステータスフィルター。デフォルトでは、すべてのタスクが照会されます。列挙値: init : 未開始。 paused : 停止。 started : 実行中。
PageNo	integer	任意	ページ番号。有効な値: [1, n)。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: [1, 100]。デフォルト値: 10。	10
SortBy	string	任意	ソート順序。タスクは CreateTime でソートされます。デフォルト値: desc。列挙値: asc : 昇順。 desc : 降順。	desc

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエストの ID。	****11-DB8D-4A9A-875B-275798****
JobList	array<object>	タスクのリスト。
	array<object>
JobId	string	タスクの ID。	**a046-263c-3560-978a-fb287782**
JobName	string	タスクの名前。	Screenshot task1
TemplateId	string	テンプレートの ID。	**a046-263c-3560-978a-fb287666**
TemplateName	string	テンプレートの名前。	Template 1
Status	string	タスクのステータス。列挙値: init : 未開始。 paused : 停止。 started : 実行中。	started
SnapshotOutput	object	出力情報。
StorageType	string	ストレージタイプ。現在は oss のみがサポートされています。	oss
Endpoint	string	出力エンドポイント。type が oss に設定されている場合、OSS ドメイン名が返されます。	oss-cn-shanghai.aliyuncs.com
Bucket	string	出力エンドポイントのバケット。type が oss に設定されている場合、OSS バケットが返されます。	testbucket
TimeInterval	integer	スナップショットの時間間隔。単位: 秒。	5
CreateTime	string	作成時刻。	2022-07-20T02:48:58Z
PageNo	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
SortBy	string	ソート順序。	desc
TotalCount	integer	エントリの総数。	100

例

成功レスポンス

JSONJSON

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobList": [
    {
      "JobId": "****a046-263c-3560-978a-fb287782****",
      "JobName": "Screenshot task1",
      "TemplateId": "****a046-263c-3560-978a-fb287666****",
      "TemplateName": "Template 1",
      "Status": "started",
      "SnapshotOutput": {
        "StorageType": "oss",
        "Endpoint": "oss-cn-shanghai.aliyuncs.com",
        "Bucket": "testbucket"
      },
      "TimeInterval": 5,
      "CreateTime": "2022-07-20T02:48:58Z"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "SortBy": "desc",
  "TotalCount": 100
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	%s
400	InvalidParameter	%s
400	MalformedStartTime	Specified parameter StartTime is not valid.
400	MalformedEndTime	Specified parameter EndTime is not valid.
400	EndTimeMismatch	Specified end time does not math the specified start time.
500	InternalError	The request processing has failed due to some unknown error.
403	UserDisable	User is disable.
403	Forbidden	User not authorized to operate on the specified resource.
403	OperationDenied	Your account has not enabled the ICE service.

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

変更履歴

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