GetLiveSnapshotJob - 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:GetLiveSnapshotJob

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
JobId	string	必須	タスク ID。	**a046-263c-3560-978a-fb287782**

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
RequestId	string	リクエスト ID。	****11-DB8D-4A9A-875B-275798****
JobId	string	タスク ID。	**a046-263c-3560-978a-fb287782**
JobName	string	タスク名。	Snapshot job 1
TemplateId	string	テンプレート ID。	**a046-263c-3560-978a-fb287666**
TemplateName	string	テンプレート名。	Template 1
Status	string	タスクステータス。列挙値: init : 未開始。 paused : 停止。 started : 実行中。	started
StreamInput	object	入力フォーマット。
Url	string	入力 URL。	rtmp://www.aliyun.com/stream
Type	string	入力タイプ。現在、RTMP のみがサポートされています。列挙値: rtmp : rtmp。	rtmp
SnapshotOutput	object	出力フォーマット。
StorageType	string	ストレージタイプ。現在、OSS のみがサポートされています。列挙値: oss : oss。	oss
Endpoint	string	出力エンドポイント。タイプが oss の場合、OSS ドメイン名が返されます。	oss-cn-shanghai.aliyuncs.com
Bucket	string	出力エンドポイントのバケット。タイプが oss の場合、OSS バケットが返されます。	testbucket
OverwriteFormat	string	上書きスナップショットフォーマット。	snapshot/{JobId}.jpg
SequenceFormat	string	シーケンススナップショットフォーマット。	snapshot/{JobId}/{UnixTimestamp}.jpg
TimeInterval	integer	スナップショット間隔。単位: 秒。	5
CallbackUrl	string	スナップショットコールバック URL。	http://www.aliyun.com/snapshot/callback
LastModified	string	最終変更済み時間。	2022-02-02T22:22:22Z
CreateTime	string	作成時間。時間は ISO 8601 フォーマットおよび協定世界時 (UTC) (末尾が Z) です。	2022-02-02T22:22:22Z

例

成功レスポンス

JSONJSON

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****a046-263c-3560-978a-fb287782****",
  "JobName": "截图任务1",
  "TemplateId": "****a046-263c-3560-978a-fb287666****",
  "TemplateName": "模板1",
  "Status": "started",
  "StreamInput": {
    "Url": "rtmp://www.aliyun.com/stream",
    "Type": "rtmp"
  },
  "SnapshotOutput": {
    "StorageType": "oss",
    "Endpoint": "oss-cn-shanghai.aliyuncs.com",
    "Bucket": "testbucket"
  },
  "OverwriteFormat": "snapshot/{JobId}.jpg",
  "SequenceFormat": "snapshot/{JobId}/{UnixTimestamp}.jpg",
  "TimeInterval": 5,
  "CallbackUrl": "http://www.aliyun.com/snapshot/callback",
  "LastModified": "2022-02-02T22:22:22Z",
  "CreateTime": "2022-02-02T22:22:22Z"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	%s
400	InvalidParameter	%s
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.
404	JobNotFound	No such job.

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

変更履歴

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