GetAiRtcAuthCodeList API リファレンス - Intelligent Media Services

操作説明

注意事項

この API は、特定のバッチ ID の認証コードのリストを取得します。結果はステータスとタイプでフィルターできます。
ページネーションは、PageNo および PageSize パラメーターを介してサポートされています。
デフォルトでは、NeedTotalCount パラメーターは true に設定されており、応答に一致するレコードの合計数が含まれることを示します。
LicenseItemId は、クエリするバッチを指定する必須パラメーターです。

今すぐお試しください

この 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:GetAiRtcAuthCodeList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LicenseItemId	string	必須	バッチの ID。	17712***
Status	integer	任意	認証コードのステータス。有効な値は次のとおりです。 `1`: アクティブ化済み `2`: 非アクティブ	1
Type	integer	任意	ライセンスのタイプ。有効な値は次のとおりです。 `1`: 音声通話 `2`: ビデオ通話	1
PageNo	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりのエントリ数。	10
NeedTotalCount	boolean	任意	応答にレコードの合計数を含めるかどうかを指定します。デフォルトは `true` です。	true

レスポンスフィールド

フィールド	型	説明	例
	object	ApiResponse<CollectionResult>
RequestId	string	リクエスト ID。	7B117AF5-2A16-412C-B127-FA6175ED1***
Success	boolean	呼び出しが成功したかどうかを示します。	true
Code	string	エラーコード。	Success
Message	string	エラーメッセージ。	OK
HttpStatusCode	integer	HTTP ステータスコード。	200
AuthCodeList	array	AiRtcAuthCodeDTO オブジェクトの配列で、それぞれが認証コードを表します。
	AiRtcAuthCodeDTO	認証コード。
TotalCount	integer	返されたエントリの合計数。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1***",
  "Success": true,
  "Code": "Success",
  "Message": "OK",
  "HttpStatusCode": 200,
  "AuthCodeList": [
    {
      "Status": 1,
      "Type": 1,
      "AuthCode": "iU1IeJech7***",
      "ActivatedTime": "2024-01-01 06:57:43",
      "DeviceId": "device-***",
      "CreationTime": "2023-12-23T13:33:49Z",
      "License": "a659a06659a***",
      "ModificationTime": "2023-12-23T13:33:49Z",
      "LicenseItemId": "11096067***"
    }
  ],
  "TotalCount": 10
}

エラーコード

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

変更履歴

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