Reset API Key

Prerequisites

You have obtained the AccessKey of an Alibaba Cloud account or a RAM user, and the identity has been granted the RAM permissions required to call this operation. We recommend that you set the AccessKey as the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET instead of hard-coding it.

Request description

HTTP method: POST
Request URL
Region
Endpoint
China (Beijing)
POST https://modelstudio.cn-beijing.aliyuncs.com/tokenplan/api-key-rotations
Authentication This operation is an Alibaba Cloud OpenAPI operation that uses AccessKey-based signatures (the ACS3-HMAC-SHA256 algorithm). The Authorization: Bearer {API_KEY} scheme is not supported. A request must carry the common headers x-acs-action: RotateTokenPlanKey, x-acs-version: 2026-02-10, x-acs-date, x-acs-content-sha256, x-acs-signature-nonce, and Authorization. We recommend that you call this operation with an Alibaba Cloud SDK or OpenAPI Explorer so that you do not have to calculate the signature yourself.

Region	Endpoint
China (Beijing)	`POST https://modelstudio.cn-beijing.aliyuncs.com/tokenplan/api-key-rotations`

Only the API key value changes. The API key ID remains unchanged.

Request parameters

All parameters are passed in the query string.

Parameter	Type	Required	Description
ApiKeyId	string	Yes	API Key ID

Response parameters

Parameter	Type	Description
Success	boolean	Whether the API call was successful: true: success false: failure
Code	string	Response status code.
Message	string	Response message.
Data	object	Business data.
ApiKeyId	string	API key ID (system generated).
SourceId	string	Source ID returned by BaiLian.
PlainApiKey	string	New plaintext API Key returned by Model Studio (returned only once at reset)
MaskedApiKey	string	New masked_api_key returned by Model Studio (for example sk_***cdef)
ResetAt	string	Reset time

Request example

This operation uses Alibaba Cloud OpenAPI signatures. In the following example, ${SIGNATURE} must be calculated with the ACS3-HMAC-SHA256 algorithm, and x-acs-date and x-acs-signature-nonce must be replaced with actual values.

curl -X POST "https://modelstudio.cn-beijing.aliyuncs.com/tokenplan/api-key-rotations?ApiKeyId=ak_123456" \
    --header "x-acs-action: RotateTokenPlanKey" \
    --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}"

Response example

{
  "Success": true,
  "Data": {
    "ApiKeyId": "ak_123456",
    "SourceId": "123456",
    "PlainApiKey": "sk-ws.abc123456",
    "MaskedApiKey": "sk_***6",
    "ResetAt": "2025-07-18T03:19:17Z"
  }
}

Error codes

If the call fails, an error message is returned. For more error codes and solutions, see Error codes.

​Prerequisites

​Request description

​Request parameters

​Response parameters

​Request example

​Response example

​Error codes