Skip to main content

APIキーの作成

UAC APIキーを作成します。

前提条件

Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey を取得しており、その ID にこの操作を呼び出すために必要な RAM 権限が付与されていること。AccessKey をハードコーディングするのではなく、環境変数 ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET として設定することを推奨します。

リクエストの説明

  • HTTP メソッド:POST
  • リクエスト URL

    リージョン

    エンドポイント

    シンガポール

    POST https://modelstudio.ap-southeast-1.aliyuncs.com/tokenplan/api-keys

  • 認証 この操作は、AccessKey ベースの署名(ACS3-HMAC-SHA256 アルゴリズム)を使用する Alibaba Cloud OpenAPI 操作です。Authorization: Bearer {API_KEY} スキームはサポートされていません。リクエストには共通ヘッダー x-acs-action: CreateTokenPlanKey、x-acs-version: 2026-02-10、x-acs-date、x-acs-content-sha256、x-acs-signature-nonce、および Authorization を含める必要があります。 署名を自分で計算する必要がないよう、Alibaba Cloud SDK または OpenAPI Explorer を使用してこの操作を呼び出すことを推奨します。

リクエストパラメーター

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

パラメーター

タイプ

必須

説明

AccountId

string

はい

アカウント ID。

Description

string

いいえ

キーの説明。

レスポンスパラメーター

パラメーター

タイプ

説明

Success

boolean

リクエストが成功したかどうか。

Code

string

エラーコード(成功時は空)。

Message

string

エラーメッセージ(成功時は空)。

Data

object

ビジネスデータ。

ApiKeyId

string

APIキーID(システム生成)。

SourceId

string

BaiLianによって返されるソースID。

PlainApiKey

string

BaiLian によって返される平文の API キー(作成時に一度だけ返されます)。

MaskedApiKey

string

BaiLianによって返されるマスクされたAPIキー(例:sk_***cdef)。

Description

string

キーの説明。

CreatedAt

string

キーの作成時刻。

リクエスト例

この操作では Alibaba Cloud OpenAPI の署名を使用します。以下の例では、${SIGNATURE} を ACS3-HMAC-SHA256 アルゴリズムで計算する必要があり、x-acs-date および x-acs-signature-nonce を実際の値に置き換える必要があります。
curl -X POST "https://modelstudio.ap-southeast-1.aliyuncs.com/tokenplan/api-keys?AccountId=acc_123456789&Description=API%20key%20description" \
    --header "x-acs-action: CreateTokenPlanKey" \
    --header "x-acs-version: 2026-02-10" \
    --header "x-acs-date: 2026-01-01T12:00:00Z" \
    --header "x-acs-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" \
    --header "x-acs-signature-nonce: ${SIGNATURE_NONCE}" \
    --header "Authorization: ACS3-HMAC-SHA256 Credential=${ALIBABA_CLOUD_ACCESS_KEY_ID},SignedHeaders=host;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version,Signature=${SIGNATURE}"

レスポンス例

{
  "Success": true,
  "Data": {
    "ApiKeyId": "ak-123456",
    "SourceId": "123",
    "PlainApiKey": "sk-ws.abc123456",
    "MaskedApiKey": "sk_***6",
    "Description": "APIKEY描述",
    "CreatedAt": "2025-07-18T03:19:17Z"
  }
}

エラーコード

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