ストリームコールバックレコードを照会します。
操作説明
この API オペレーションの単一ユーザーに対する QPS 制限は、1 秒あたり 100 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。適切な頻度でこの操作を呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:DescribeLiveStreamsNotifyRecords |
get |
*Domain
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| DomainName |
string |
必須 |
アップストリーミングドメイン。 |
push.example1.com |
| AppName |
string |
任意 |
ライブストリームが属するアプリケーションの名前。AppName はストリーム管理ページで確認できます。 |
app |
| StreamName |
string |
任意 |
ライブストリームの名前。StreamName はストリーム管理ページで確認できます。 |
stream |
| Status |
string |
任意 |
コールバックが成功したかどうかを指定します。有効な値:
列挙値:
|
success |
| StartTime |
string |
必須 |
開始時刻。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。 説明
開始時刻は過去 7 日以内である必要があります。 |
2017-12-10T08:00:00Z |
| EndTime |
string |
必須 |
終了時刻。終了時刻は開始時刻より後である必要があります。フォーマット: yyyy-MM-ddTHH:mm:ssZ (協定世界時 (UTC))。 |
2017-12-10T09:00:00Z |
| PageSize |
integer |
任意 |
ページサイズ。デフォルト値: 20。最大値: 500。有効な値: 1~500 の任意の整数。 |
20 |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
アップストリーミングコールバックレコード。 |
||
| NotifyRecordsInfo |
object |
||
| LiveStreamNotifyRecordsInfo |
array<object> |
アップストリーミングコールバックレコード。 |
|
|
object |
|||
| NotifyType |
string |
コールバックタイプ。
|
publish_done |
| Description |
string |
結果の説明。 成功した場合は「success」を返します。 失敗した場合はエラーメッセージを返します。 |
success |
| StreamName |
string |
ライブストリーム名。 |
stream |
| NotifyTime |
string |
コールバックが発生した時刻。 時刻は UTC です。 |
2022-10-19T19:09:28Z |
| DomainName |
string |
アップストリーミングドメイン。 |
push.example1.com |
| NotifyContent |
string |
コールバックの内容。 |
{\"action\":\"publish_done\",\"app\":\"push.example1.com\"} |
| NotifyUrl |
string |
コールバック URL。 |
http://xx.xx.xx.xx/callbacks |
| NotifyResult |
string |
コールバック結果。
|
success |
| AppName |
string |
ライブストリームを含むアプリケーションの名前。 |
app |
| NotifyResponse |
string |
サーバーがコールバックを受信した後にサーバーから返される応答。 |
{"Code":0,"Msg":"Success"} |
| NotifyHeader |
string |
コールバックリクエストのリクエストヘッダー。 |
Host: 123456.cn-shanghai.example1.com User-Agent: Go-http-client/1.1 Accept-Encoding: gzip |
| PageNum |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
ページサイズ。 |
20 |
| RequestId |
string |
リクエスト ID。 |
F675E4B4-125D-1533-901B-11A724644285 |
| TotalNum |
integer |
指定された条件に一致するエントリの総数。 |
20 |
| TotalPage |
integer |
総ページ数。 |
20 |
例
成功レスポンス
JSONJSON
{
"NotifyRecordsInfo": {
"LiveStreamNotifyRecordsInfo": [
{
"NotifyType": "publish_done",
"Description": "success",
"StreamName": "stream",
"NotifyTime": "2022-10-19T19:09:28Z",
"DomainName": "push.example1.com",
"NotifyContent": "{\\\"action\\\":\\\"publish_done\\\",\\\"app\\\":\\\"push.example1.com\\\"}",
"NotifyUrl": "http://xx.xx.xx.xx/callbacks",
"NotifyResult": "success",
"AppName": "app",
"NotifyResponse": "{\"Code\":0,\"Msg\":\"Success\"}",
"NotifyHeader": "Host: 123456.cn-shanghai.example1.com\nUser-Agent: Go-http-client/1.1\nAccept-Encoding: gzip"
}
]
},
"PageNum": 1,
"PageSize": 20,
"RequestId": "F675E4B4-125D-1533-901B-11A724644285",
"TotalNum": 20,
"TotalPage": 20
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | |
| 400 | InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | |
| 400 | InvalidParam | Parameter invalid. | |
| 400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | |
| 400 | Duration.Exceed | StartTime needs to be within the last 7 days. | |
| 500 | InternalError | The request processing has failed due to backend service exception. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。