Skip to main content

モデルの権限一覧

GET /api/v1/models/permissions エンドポイントを呼び出して、現在のワークスペースで認可可能または認可済みのモデルのリストとその権限の詳細を照会します。

前提条件

API キーが作成され、環境変数 DASHSCOPE_API_KEY として設定されています。詳細については、「環境変数での API キーの設定」をご参照ください。

リクエスト

  • HTTP メソッド：GET
  • リクエスト URL
    {WorkspaceId} を実際のワークスペース ID に置き換えてください。

    リージョン

    エンドポイント

    中国 (北京)

    https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/models/permissions

  • 認証 リクエストヘッダーで Authorization: Bearer {API_KEY} を設定してください。

リクエストパラメーター

すべてのパラメーターはクエリ文字列を介して渡されます。

パラメーター

タイプ

必須

説明

name

文字列

いいえ

モデル名によるあいまい検索。name と model_id に対してあいまい一致を実行します。例： qwen

model

文字列

いいえ

モデル ID による完全一致。model_id に対して完全一致を実行します。例： qwen-plus

page_no

整数

いいえ

ページ番号。1 から始まる正の整数です。デフォルト値： 1。

page_size

整数

いいえ

1 ページあたりの件数。範囲は 1 ～ 200 (最大 200) です。デフォルト値： 20。

authorization_scope

文字列

いいえ

認可スコープフィルター。有効な値：

  • AUTHORIZABLE：認可可能なモデル (デフォルト)。

  • AUTHORIZED：認可済みのモデル。

デフォルト値： AUTHORIZABLE。例： AUTHORIZED

action

文字列

いいえ

権限アクションのディメンション。有効な値： INFERENCE - 推論 (現在サポートされている唯一の値)。このフィルターディメンションは、authorization_scope=AUTHORIZED の場合にのみ有効です。デフォルト値： INFERENCE。

レスポンスパラメーター

パラメーター

タイプ

説明

request_id

文字列

リクエスト ID。例： d5f5201f-ee7a-9e3d-8569-bc0eedec21f9

code

文字列

エラーコード。成功した場合は null。

message

文字列

エラーメッセージ。成功した場合は null。

success

ブール値

呼び出しが成功したかどうか。例： true

output.total

数値

合計件数。例： 5

output.page_no

数値

ページ番号。例： 1

output.page_size

数値

1 ページあたりの件数。例： 20

output.permissions

配列 [オブジェクト]

権限リスト。レスポンス例をご参照ください。

output.model

文字列

モデル ID。例： qwen-plus

output.name

文字列

モデルの表示名。例： Qwen-Plus

output.permissions[].permissions

オブジェクト

権限の詳細。例： {"inference":true,"fine_tune":false,"deploy":false}。次のフィールドが含まれます：

  • inference (ブール値)：モデルの呼び出し権限があるかどうか。例： true

  • finetune (ブール値)：モデルトレーニング権限があるかどうか。例： false

  • deploy (ブール値)：モデルデプロイ権限があるかどうか。例： false

リクエスト例 

curl "https://dashscope.aliyuncs.com/api/v1/models/permissions?authorization_scope=AUTHORIZED&action=INFERENCE&page_no=1&page_size=20" \
    --header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
    --header 'Content-Type: application/json'

レスポンス例 

{
    "code": null,
    "message": null,
    "success": true,
    "output": {
        "total": 1,
        "page_no": 1,
        "page_size": 20,
        "permissions": [
            {
                "model": "qwen-plus",
                "name": "通义千问-Plus",
                "permissions": {
                    "inference": true,
                    "fine_tune": false,
                    "deploy": false
                }
            }
        ]
    },
    "request_id": "d5f5201f-ee7a-9e3d-8569-bc0eedec21f9"
}

エラーコード

呼び出しが失敗した場合、エラーメッセージが返されます。エラーメッセージとその解決策の詳細については、「エラーメッセージ」をご参照ください。