ListHotwordLibraries API 概要 - IMS

特定の検索条件を満たすホットワードライブラリをクエリします。

操作説明

この操作を呼び出して、作成されたすべてのホットワードライブラリに関する情報を取得できます。
API は、Name によるあいまい検索、作成時間範囲によるフィルター、およびページネーションをサポートしています。
デフォルトでは、結果は作成時間で降順にソートされます。SortBy を設定してソート順を変更できます。
各リクエストで返される最大エントリ数は 100 です。デフォルト値：10。
ページネーションには NextToken を使用します。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。	**73f33c91-d59383e8280b**
PageNo	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。デフォルト値：10。有効な値：1～100。	10
SortBy	string	任意	ソート順。デフォルトでは、クエリ結果は作成時間で降順にソートされます。	CreationTime:Desc
Name	string	任意	ホットワードライブラリ名。	热词库使用名称
UsageScenario	string	任意	ホットワードライブラリの使用シナリオ。有効な値： ASR：自動音声認識 StructuredMediaAssets：構造化メディア分析 VideoTranslation：動画翻訳。このフィールドは、ホットワードライブラリの作成後に変更できません。	ASR
StartTime	string	任意	クエリする時間範囲の開始。	2020-12-26T04:11:10Z
EndTime	string	任意	クエリする時間範囲の終了。	2020-12-26T04:11:10Z
MaxResults	integer	任意	返される最大エントリ数。デフォルト値：10。有効な値：1～100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	**9262E3DA-07FA-4862-FCBB6BC61D08***
NextToken	string	次のリクエストで新しい結果ページを取得するために使用できるページネーショントークン。空の場合、すべての結果が返されます。	CBB6BC61D08
MaxResults	integer	返されるホットワードライブラリの最大数。	10
TotalCount	integer	ホットワードライブラリの合計数。	20
HotwordLibraryList	array<object>	ホットワードライブラリ。
	object
Description	string	ホットワードライブラリの説明。最大 200 文字です。	存放名人的词库
UsageScenario	string	ホットワードライブラリの使用シナリオ。有効な値： ASR：自動音声認識 StructuredMediaAssets：構造化メディア分析 VideoTranslation：動画翻訳。このフィールドは、ホットワードライブラリの作成後に変更できません。	ASR
ModifiedTime	string	ホットワードライブラリが最終変更された時間。	2017-01-11T12:00:00Z
CreationTime	string	ホットワードライブラリが作成された時間。	2017-01-11T12:00:00Z
HotwordLibraryId	string	ホットワードライブラリ ID。	a93b91141c0f422fa114af203f8b****
Name	string	ホットワードライブラリ名。	my_hotwords

例

成功レスポンス

JSONJSON

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "NextToken": "CBB6BC61D08",
  "MaxResults": 10,
  "TotalCount": 20,
  "HotwordLibraryList": [
    {
      "Description": "存放名人的词库",
      "UsageScenario": "ASR",
      "ModifiedTime": "2017-01-11T12:00:00Z\n",
      "CreationTime": "2017-01-11T12:00:00Z",
      "HotwordLibraryId": "a93b91141c0f422fa114af203f8b****",
      "Name": "my_hotwords"
    }
  ]
}

エラーコード

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

変更履歴

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