GetCategories でカテゴリとサブカテゴリ情報をクエリ - IMS - Alibaba Cloud - Intelligent Media Services

カテゴリとそのサブカテゴリの情報を照会します。

操作説明

カテゴリ ID とカテゴリタイプに基づいて、カテゴリとそのサブカテゴリの情報を照会します。

今すぐお試しください

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

読み取り

*すべてのリソース

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CateId	整数	任意	カテゴリ ID。次のいずれかの方法で ID を取得できます。 Intelligent Media Services (IMS) コンソールにログインし、[メディアアセット管理] > [カテゴリ管理] を選択してカテゴリ ID を確認します。カテゴリを作成するために呼び出した AddCategory API が返す CateId の値を確認します。カテゴリを照会するために呼び出した GetCategories API が返す CateId の値を確認します。	33
PageNo	整数	任意	ページ番号。デフォルト値： 1	1
PageSize	整数	任意	ページあたりのエントリー数。有効な値： 10～100	10
SortBy	文字列	任意	結果のソート順。有効な値： - CreationTime:Desc (デフォルト)：作成日時に基づいて降順でソートします。 - CreationTime:Asc：作成日時に基づいて昇順でソートします。	CreationTime:Desc
Type	文字列	任意	カテゴリタイプ。有効な値： default、material。default はオーディオファイル、ビデオファイル、画像ファイルを示し、これがデフォルト値です。material は短尺動画素材を示します。	default

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト
SubTotal	整数	サブカテゴリの総数。	100
RequestId	文字列	リクエスト ID。	****3B-0E1A-586A-AC29-742247****
Category	オブジェクト	カテゴリに関する情報。
Type	文字列	カテゴリタイプ。有効な値： default：オーディオファイル、ビデオファイル、画像ファイル。これがデフォルト値です。 material：短尺動画素材。	default
CateName	文字列	カテゴリ名。	レベル 1 カテゴリ
ParentId	整数	親カテゴリの ID。	-1
CateId	整数	カテゴリ ID。	46
Level	整数	カテゴリのレベル。0 はレベル 1 カテゴリを、1 はレベル 2 カテゴリを、2 はレベル 3 カテゴリを示します。	0
SubCategories	オブジェクト
Category	配列 <オブジェクト>	カテゴリ内のサブカテゴリ。
	オブジェクト	カテゴリ内のサブカテゴリ。
Type	文字列	カテゴリタイプ。有効な値： default：オーディオファイル、ビデオファイル、画像ファイル。これがデフォルト値です。 material：短尺動画素材。	default
CateName	文字列	カテゴリ名。最大 64 バイトです。 UTF-8 でエンコードされています。	レベル 2 サブカテゴリ
ParentId	整数	親カテゴリの ID。	46
CateId	整数	カテゴリ ID。	129
SubTotal	整数	サブカテゴリの総数。	100
Level	整数	カテゴリのレベル。0 はレベル 1 カテゴリを、1 はレベル 2 カテゴリを、2 はレベル 3 カテゴリを示します。	1

例

成功レスポンス

JSONJSON

{
  "SubTotal": 100,
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Category": {
    "Type": "default",
    "CateName": "レベル 1 カテゴリ",
    "ParentId": -1,
    "CateId": 46,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "レベル 2 サブカテゴリ",
        "ParentId": 46,
        "CateId": 129,
        "SubTotal": 100,
        "Level": 1
      }
    ]
  }
}

エラーコード

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

変更履歴

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