Skip to main content

建立 API Key

建立 UAC API Key

前提條件

已取得阿里雲帳號或 RAM 使用者的 AccessKey，並已為其授予呼叫此 API 所需的 RAM 權限。建議將 AccessKey 設定為環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET，避免以明文寫入程式碼。

請求說明

  • HTTP 方法：POST
  • 請求地址

    地域

    Endpoint

    新加坡

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

  • 驗證方式 此 API 為阿里雲 OpenAPI，採用 AccessKey 簽名（簽名演算法 ACS3-HMAC-SHA256），不支援 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。 建議使用阿里雲 SDK 或 OpenAPI Explorer 發起呼叫，可免去自行計算簽名。

請求參數

所有參數均透過 Query String 傳遞。

參數

類型

必選

描述

AccountId

string

是

帳號 ID

Description

string

否

Key 描述

返回參數

參數

類型

描述

Success

boolean

是否成功

Code

string

錯誤碼（成功時為空）

Message

string

錯誤訊息（成功時為空）

Data

object

業務資料

ApiKeyId

string

API Key ID（系統產生）

SourceId

string

BaiLian 返回的 source_id

PlainApiKey

string

BaiLian 返回的明文 API Key（只在建立時返回一次）

MaskedApiKey

string

BaiLian 返回的 masked_api_key（如 sk_***cdef）

Description

string

Key 描述

CreatedAt

string

Key 建立時間

請求範例

此 API 使用阿里雲 OpenAPI 簽名，下列範例中的 ${SIGNATURE} 需按 ACS3-HMAC-SHA256 演算法計算得出，x-acs-date、x-acs-signature-nonce 需替換為實際值。範例 URL 中的中文取值為便於閱讀未做編碼；實際計算簽名時，規範化請求（CanonicalRequest）的 Query String 需按 RFC 3986 對鍵和取值進行百分比編碼，否則會返回 SignatureDoesNotMatch。使用阿里雲 SDK 時會自動處理。 
curl -X POST "https://modelstudio.ap-southeast-1.aliyuncs.com/tokenplan/api-keys?AccountId=acc_123456789&Description=APIKEY描述" \
    --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: 3e3b2a9f0c7d4f8e9a1b2c3d4e5f6a7b" \
    --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"
  }
}

錯誤碼

如果呼叫失敗，會返回錯誤訊息。更多錯誤碼及解決方法，請參閱錯誤訊息。