この操作を呼び出すと、作成されたチャンネルのリストが取得できます。
パラメータのリクエスト
名前 | タイプ | 必須/省略可能 | 説明 |
---|---|---|---|
Action | String | 必須 | 実行する操作。 値を DescribeRoomList に設定します。 |
AppId | String | 必須 | サービスプロバイダーのアプリケーション ID。 |
RoomStatus | int | 任意 | アップストリーミングステータス。 設定可能な値は次のとおりです。
|
Order | String | 任意 | ソート順。
デフォルト値:desc (降順)。 |
PageNum | int | 任意 | ページ番号。
既定値 : 1。 |
PageSize | int | 任意 | 1 ページあたりのレコード数。
デフォルト値:10。 |
レスポンスのパラメータ
名前 | データ型 | 説明 |
---|---|---|
RequestId | String | Alibaba Cloud によって生成された、リクエストに対する GUID。 |
TotalNum | int | レコードの総数。 |
TotalPage | int | ページの総数。 |
RoomList | JsonArray | チャンネルのリスト。 |
Room
名前 | データ型 | 説明 |
---|---|---|
RoomId | String | チャンネルの ID。 |
AnchorId | String | 配信者の ID。 |
RoomStatus | int | アップストリーミングステータス。 設定可能な値は次のとおりです。
|
CreateTime | String | チャンネルが作成された時刻。
YYYY-MM-DDThh:mm:ssZ 形式です。 |
コーディング例
リクエスト例
https://live.aliyuncs.com?Action=DescribeRoomList&AppId=xxxx&RoomId=xxx&<Common request parameters>
レスポンスの例
{
"TotalPage": 1,
"TotalNum": 2,
"RequestId": "EB8B1220-9B1D-4B1E-A7F8-F02E872BBA2C",
"RoomList": {
"Room": [
{
"Status": 0,
"AnchorId": "c8624b97b7b54acba4b65951c12d3c5b",
"RoomId": "ewynykkf3nftbzqo",
"CreateTime": "2018-05-25T03:00:08Z"
},
{
"Status": 0,
"AnchorId": "2f078371-d06e-40d5-8dee-d1c6149afa1e",
"RoomId": "hello_wxg_room",
"CreateTime": "2018-05-24T08:58:26Z"
}
]
}
}
エラーコード
エラーコード | エラーメッセージ | HTTP ステータスコード | 説明 |
---|---|---|---|
InternalError | The request processing has failed due to some unknown error, exception or failure. | 500 | 内部エラーが発生したときに返されるエラーメッセージです。 |