すべてのプロダクト
Search

このプロダクト

    :GetCategories

    ドキュメントセンター

    :GetCategories

    最終更新日:Dec 15, 2025

    カテゴリの 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vod:GetCategories

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    CateId

    integer

    任意

    カテゴリの ID。このパラメーターを指定すると、システムは ID に基づいてカテゴリを照会します。指定できるカテゴリ ID は 1 つだけです。次のいずれかの方法で ID を取得できます。

    • ApsaraVideo VOD コンソールにログインします。[設定管理] > [メディア管理] > [カテゴリ] を選択します。[音声・動画/画像カテゴリ] または [ショートビデオ素材カテゴリ] タブで、カテゴリ ID を表示します。

    • AddCategory 操作のレスポンスからカテゴリ ID を取得します。

    49339****
    PageNo

    integer

    任意

    返されるサブカテゴリがリストされるページ番号。デフォルト値：1。

    1
    PageSize

    integer

    任意

    サブカテゴリリストの各ページで返すエントリ数。デフォルト値：10。最大値：100。

    10
    SortBy

    string

    任意

    結果のソート方法。有効な値：

    • CreationTime:Desc (デフォルト)：作成時間に基づいて、結果を逆時系列順にソートします。

    • CreationTime:Asc：作成時間に基づいて、結果を時系列順にソートします。

    CreationTime:Desc
    Type

    string

    任意

    カテゴリのタイプ。このパラメーターを指定すると、システムはタイプに基づいてカテゴリを照会します。有効な値：

    • default (デフォルト)：オーディオ、ビデオ、および画像ファイル

    • material：ショートビデオ素材

    default

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    SubTotal

    integer

    サブカテゴリの総数。

    3795
    RequestId

    string

    リクエストの ID。

    25818875-5F78-4AF6-D7393642CA58****
    Category

    object

    カテゴリに関する情報。

    Type

    string

    カテゴリのタイプ。有効な値：

    • default：オーディオ、ビデオ、および画像ファイル

    • material：ショートビデオ素材

    default
    ParentId

    integer

    親カテゴリの ID。

    100012****
    CateName

    string

    カテゴリの名前。

    film
    CateId

    integer

    カテゴリの ID。

    100
    Level

    integer

    カテゴリのレベル。有効な値：

    • 0：レベル 1 カテゴリ

    • 1：レベル 2 カテゴリ

    • 2：レベル 3 カテゴリ

    0
    SubCategories

    object

    Category

    array<object>

    サブカテゴリの詳細。

    object

    サブカテゴリのリスト。

    Type

    string

    サブカテゴリのタイプ。有効な値：

    • default：オーディオ、ビデオ、および画像ファイル

    • material：ショートビデオ素材

    default
    CateName

    string

    カテゴリの名前。

    film
    ParentId

    integer

    親カテゴリの ID。

    10020****
    CateId

    integer

    カテゴリの ID。

    100
    SubTotal

    integer

    サブカテゴリの総数。

    1
    Level

    integer

    カテゴリのレベル。有効な値：

    • 0：レベル 1 カテゴリ

    • 1：レベル 2 カテゴリ

    • 2：レベル 3 カテゴリ

    1

    例

    成功レスポンス

    JSONJSON

    {
  "SubTotal": 3795,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Category": {
    "Type": "default",
    "ParentId": 0,
    "CateName": "film",
    "CateId": 100,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "film",
        "ParentId": 0,
        "CateId": 100,
        "SubTotal": 1,
        "Level": 1
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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