ListEdgeTranscodeJob でエッジトランスコードジョブをクエリ - LIVE - Alibaba Cloud - ApsaraVideo Live

エッジトランスコード中タスクのリストを照会します。

操作説明

この操作は、エッジトランスコード中タスクのリストを照会します。
この操作を呼び出す前に、エッジトランスコード中サービスにアクセスする権限が必要です。
この操作は過去 180 日間のタスクのみを返し、最終操作時間もこの 180 日の期間内である必要があります。

QPS 制限

この操作の単一ユーザー QPS 制限は、1 分あたり 6,000 回の呼び出しです。制限を超えると API 呼び出しがスロットリングされ、ビジネスに影響が出る可能性があります。必要に応じてこの操作を呼び出してください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:ListEdgeTranscodeJob

list

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
ClusterId	string	必須	データセンター ID。	cluster-1
Type	string	任意	エッジトランスコード中のタイプ。有効な値: common: デフォルトトランスコーディング (標準 + Narrowband HD 1.0)。 nbhd-2: Narrowband HD 2.0。 ultra-hd: 超高解像度。説明このパラメーターが指定されていない場合、ユーザーが対応するトランスコード中のタイプの権限を持つトランスコーディングテンプレートが表示されます。	common
Status	integer	任意	エッジトランスコード中タスクのステータス。有効な値: 0: 未開始。 1: 実行中。	0
PageNo	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	20
SortBy	string	任意	CreateTime に基づくソート順。デフォルト値: desc。有効な値: desc: 降順ソート。 asc: 昇順ソート。	desc
Keyword	string	任意	検索キーワード。有効な値: タスク ID。完全に一致がサポートされています。タスク名。あいまい一致がサポートされています。	test

リクエストパラメーターの説明

この操作は、トランスコード中タイプ (Type) およびトランスコード中ノードステータス (Status) による結果のフィルタリングクエリをサポートしています。
この操作は、ノード作成時間 (CreateTime) による結果のソートをサポートしています。デフォルトのソート順序は降順です。
この操作は、キーワード (Keyword) によるクエリをサポートしており、ノード ID (完全に一致) またはノード名 (あいまい一致) を指定できます。

レスポンスフィールド

フィールド	型	説明	例
	object
JobList	object
Job	array<object>	エッジトランスコード中タスクのリスト。
	object
CreateTime	string	ジョブが作成された時刻。	2023-07-24T16:44:55Z
JobId	string	ジョブ ID。	**20b48fb04483915d4f2cd8ac**
LastStartAt	string	ジョブが最後に開始された時刻。	2023-07-25T02:48:58Z
LastStopAt	string	ジョブが最後に停止された時刻。	2023-07-25T05:48:58Z
Name	string	ジョブ名。	my_job
Status	string	エッジトランスコーディングジョブのステータス。有効な値： 0: ジョブは開始されていません。 1: ジョブは実行中です。	0
StreamInput	string	入力ストリーム URL。	rtmp://mydomain/app/stream1
StreamOutput	string	出力ストリーム URL。	rtmp://testdomain/app/stream2
TemplateId	string	ジョブで使用されるエッジトランスコーディングテンプレートの ID。	9b1571b513cb44f7a1ba6ae561ff****
TemplateName	string	ジョブで使用されるエッジトランスコーディングテンプレートの名前。	my_template
Type	string	エッジトランスコーディングタイプ。有効な値： common: 標準トランスコーディングとナローバンド HD 1.0。 nbhd-2: ナローバンド HD 2.0。 ultra-hd: 超高解像度。	common
RequestId	string	リクエスト ID。	****3B-0E1A-586A-AC29-742247****
TotalCount	integer	返されるエントリの総数。	100

例

成功レスポンス

JSONJSON

{
  "JobList": {
    "Job": [
      {
        "CreateTime": "2023-07-24T16:44:55Z",
        "JobId": "****20b48fb04483915d4f2cd8ac****",
        "LastStartAt": "2023-07-25T02:48:58Z",
        "LastStopAt": "2023-07-25T05:48:58Z",
        "Name": "my_job",
        "Status": "0",
        "StreamInput": "rtmp://mydomain/app/stream1",
        "StreamOutput": "rtmp://testdomain/app/stream2",
        "TemplateId": "9b1571b513cb44f7a1ba6ae561ff****",
        "TemplateName": "my_template",
        "Type": "common"
      }
    ]
  },
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TotalCount": 100
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	%s.	パラメーターが無効です。
400	MissingParameter	%s.	必須パラメーターが不足しています。
403	OperationDenied	%s, please check and try again later.	操作が拒否されました。リクエストを確認して再試行してください。

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

変更履歴

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