エッジトランスコード中タスクのリストを照会します。
操作説明
-
この操作は、エッジトランスコード中タスクのリストを照会します。
-
この操作の呼び出しには、エッジトランスコード中サービスにアクセスする権限が必要です。
-
この操作は過去 180 日間のタスクのみを返し、最終操作時間はこの 180 日間の期間内である必要があります。
QPS 制限
この操作の 1 ユーザーに対する QPS 制限は、1 分あたり 6,000 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。必要に応じてこの操作を呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:ListEdgeTranscodeJob |
list |
*ドメイン。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| ClusterId |
string |
必須 |
データセンター ID。具体的な値は、チケットを提出するか、合意された規則に従ってアカウントマネージャーに相談して決定する必要があります。チケットを提出するには、お問い合わせ を参照してください。 |
cluster-1 |
| Type |
string |
任意 |
エッジトランスコード中タイプ。有効な値:
説明
このパラメーターが指定されていない場合、ユーザーが対応するトランスコード中タイプの権限を持つトランスコーディングテンプレートが表示されます。 |
common |
| Status |
integer |
任意 |
エッジトランスコード中タスクのステータス。有効な値:
|
0 |
| PageNo |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページサイズ。デフォルト値: 10。最大値: 100。 |
20 |
| SortBy |
string |
任意 |
ソートルール。結果は CreateTime でソートされます。デフォルト値: desc。有効な値:
|
desc |
| Keyword |
string |
任意 |
検索キーワード。有効な値:
|
test |
リクエストパラメーターの説明
この操作は、トランスコード中タイプ (Type) およびトランスコード中タスクのステータス (Status) によるクエリ結果のフィルタリングをサポートしています。
この操作は、タスクの作成時間 (CreateTime) によるクエリ結果のソートをサポートしています。デフォルトのソート注文は降順です。
この操作は、タスク ID (完全に一致) またはタスク名 (あいまい一致) を使用したキーワード (Keyword) によるクエリをサポートしています。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| JobList |
object |
||
| Job |
array<object> |
エッジトランスコード中タスクのリスト。 |
|
|
object |
|||
| CreateTime |
string |
タスクが作成された時間。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。 |
2023-07-24T16:44:55Z |
| JobId |
string |
タスク ID。 |
****20b48fb04483915d4f2cd8ac**** |
| LastStartAt |
string |
タスクが最後に開始された時間。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。 |
2023-07-25T02:48:58Z |
| LastStopAt |
string |
タスクが最後に停止された時間。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (協定世界時 (UTC)) です。 |
2023-07-25T05:48:58Z |
| Name |
string |
タスク名。 |
my_job |
| Status |
string |
エッジトランスコード中タスクのステータス。有効な値:
|
0 |
| StreamInput |
string |
入力ストリーム URL。 |
rtmp://mydomain/app/ストリーム1 |
| StreamOutput |
string |
出力ストリーム URL。 |
rtmp://testdomain/app/ストリーム2 |
| TemplateId |
string |
タスクで使用されるエッジトランスコーディングテンプレートの ID。 |
9b1571b513cb44f7a1ba6ae561ff**** |
| TemplateName |
string |
タスクで使用されるエッジトランスコーディングテンプレートの名前。 |
マイ_テンプレート |
| Type |
string |
エッジトランスコード中タイプ。有効な値:
|
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. | 操作が拒否されました。リクエストを確認して再試行してください。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。