すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeModelApis

    ドキュメントセンター

    PolarDB:DescribeModelApis

    最終更新日:Aug 25, 2026

    モデル API を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeModelApis

    none

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GwClusterId

    string

    必須

    ゲートウェイインスタンスの ID。

    pg-xxxxxxxxxx
    ModelApiIds

    string

    任意

    モデル API の ID。

    mi-xxx,mi-xxxx
    Name

    string

    任意

    モデル API 名。

    testName
    ModelCategory

    string

    任意

    モデルのカテゴリ。有効な値:

    • text

    • 埋め込み

    • rerank

    text
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効な値:

    • 30

    • 50

    • 100

    デフォルト値: 30。

    30
    PathPrefix

    string

    任意

    API パスのプレフィックス。

    /test
    Protocol

    string

    任意

    プロトコル。有効な値:

    • openai

    • anthropic

    • bailian

    • vllm

    openai
    Status

    string

    任意

    モデル API のステータス。

    Enable
    RegionId

    string

    任意

    リージョン ID。

    cn-beijing

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。

    C61892A4-0850-4516-9E26-44D96C1782DE
    TotalRecordCount

    integer

    レコードの総数。

    1
    PageRecordCount

    integer

    現在のページのレコード数。

    30
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効な値: 30、50、または 100。

    デフォルト値: 30。

    30
    Items

    array<object>

    モデル API のリスト。

    object

    モデル API オブジェクト。

    ModelApiId

    string

    モデル API の ID。

    mi-xxxx
    Name

    string

    モデル API 名。

    testName
    Category

    string

    モデルのカテゴリ。有効な値:

    • text

    • 埋め込み

    • rerank

    text
    Status

    string

    モデル API のステータス。

    Enable
    Protocol

    string

    プロトコル。有効な値:

    • openai

    • anthropic

    • bailian

    • vllm

    openai
    PathPrefix

    string

    API パスのプレフィックス。

    tests/models/
    RecordInput

    string

    入力トークン数。

    10
    RecordOutput

    string

    出力トークン数。

    10
    RouteRules

    string

    ルーティングルールのリスト (JSON 配列文字列)。

    [ { "RuleName": "string", "FallbackMode": "failover", "MatchModelListJson": "[]", "providerBalancerAlgorithm": "round-robin", "Providers": [ { "ModelServiceName": "string", "Weight": "0", "model_protocol": "vllm" "ModelList": "[]" } ], "FallbackProviders": [ { "ModelServiceName": "string", "model_protocol": "anthropic", "Weight": "10", "ModelList": "[]" } ] } ]
    Config

    string

    GmtCreated

    string

    作成時間。

    2024-10-16 16:46:20

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "C61892A4-0850-4516-9E26-44D96C1782DE",
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "ModelApiId": "mi-xxxx",
      "Name": "testName",
      "Category": "text",
      "Status": "Enable",
      "Protocol": "openai",
      "PathPrefix": "tests/models/",
      "RecordInput": "10",
      "RecordOutput": "10",
      "RouteRules": "[\n  {\n    \"RuleName\": \"string\",\n    \"FallbackMode\": \"failover\",\n    \"MatchModelListJson\": \"[]\",\n    \"providerBalancerAlgorithm\": \"round-robin\",\n    \"Providers\": [\n      {\n        \"ModelServiceName\": \"string\",\n        \"Weight\": \"0\",\n        \"model_protocol\": \"vllm\"\n        \"ModelList\": \"[]\"\n      }\n    ],\n    \"FallbackProviders\": [\n      {\n        \"ModelServiceName\": \"string\",\n        \"model_protocol\": \"anthropic\",\n        \"Weight\": \"10\",\n        \"ModelList\": \"[]\"\n      }\n    ]\n  }\n]",
      "Config": "",
      "GmtCreated": "2024-10-16 16:46:20\n"
    }
  ]
}

    エラーコード

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

    変更履歴

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