API キーをバッチで作成します。
操作説明
各クラスターでは、同時に最大 3 つの手動作成バックアップを保持できます。
エラーメッセージ
Exceeding the daily backup times of this DB clusterが返された場合、クラスター内にすでに 3 つの手動作成バックアップが存在します。この操作を呼び出す前に、バックアップの削除 を行ってください。この操作を呼び出すと、バックグラウンドでバックアップタスクが作成されます。データ量が large の場合、バックアップに時間がかかることがあります。バックアップが完了するまでお待ちください。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| GwClusterId |
string |
必須 |
ゲートウェイインスタンスの ID。 |
pg-xxxxxxxx。 |
| Count |
integer |
任意 |
ユーザー API キーの数。 |
1 |
| ConsumerGroupId |
string |
任意 |
ユーザーグループの ID。 |
cg-xxxxxx。 |
| ClientToken |
string |
任意 |
リクエストの冪等性を確保し、重複送信を防ぐために使用されるクライアントトークン。トークンはクライアントによって生成され、異なるリクエスト間で一意である必要があります。トークンは大文字と小文字が区別され、長さは 64 ASCII 文字を超えることはできません。 |
6000170000591aed949d0f5******************** |
| CreditToken |
string |
任意 |
引き換えコード。指定した場合、チャージタイプの有効化ブランチが使用され、数量とクォータがデータベースから取得されます。 |
"9" |
| Description |
string |
任意 |
消費者の説明のプレフィックス。 |
myapp。 |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-beijing。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| RequestId |
string |
リクエストの ID。 |
A7E6A8FD-C50B-46B2-BA85-D8B8D3****** |
| TotalRecordCount |
integer |
Record の総数。 |
2 |
| PageRecordCount |
integer |
現在のページの Record 数。 |
1 |
| PageNumber |
integer |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
1 ページあたりの Record 数。有効な値:
デフォルト値: 30。 |
30 |
| TotalPages |
integer |
ページの総数。 |
1 |
| Items |
array<object> |
消費者オブジェクトのリスト。 |
|
|
object |
消費者オブジェクト。 |
||
| ConsumerId |
string |
ユーザーの ID。 |
c-mqveroemc*** |
| Name |
string |
名前。 |
test。 |
| ConsumerGroupId |
string |
ユーザーグループの ID。 |
cg-xxxxxx。 |
| ConsumerTag |
string |
消費者タグ。 |
test。 |
| ApiKey |
string |
完全な API キー。この応答でのみ返されます。 |
xxxxxxxx。 |
| GwClusterId |
string |
ゲートウェイインスタンスの ID。 |
pg-xxxxxxxxxx。 |
| ApiStatus |
string |
API キーのステータス。デフォルト値: Active。 |
Active。 |
| ApiKeyStatus |
string |
API キーのステータス。デフォルト値: Active。 |
Active。 |
| Status |
string |
消費者のステータス。デフォルト値: Enabled。 |
Enabled。 |
| GmtCreated |
string |
作成時間。 |
2024-10-16 16:46:20 |
| GmtModified |
string |
最終更新時間。 |
2026-01-04T16:09:29+08:00 |
| Description |
string |
アプリケーションの説明または備考。 |
myapp。 |
| ApiKeyMd5 |
string |
API キーの MD5 ハッシュ。 |
0769a11c2d474f96fbb527f8e273d3de。 |
| BudgetPolicyId |
string |
予算ポリシーの ID。各キーには独立した予算ポリシーがあります。 |
023aacc1effc4b56bb154bfbec6ba9** |
| BudgetLimit |
integer |
予算上限。パッケージごとのクレジット数と同等です。 |
3000 |
| BudgetUsed |
integer |
使用済みのクォータ。 |
0 |
| ExpireTime |
string |
有効期限時間。 |
2025-06-25T09:37:10Z |
| Active |
boolean |
キーがアクティブかどうかを示します。 |
true。 |
| Expired |
boolean |
キーが期限切れかどうかを示します。 |
false。 |
例
成功レスポンス
JSONJSON
{
"RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
"TotalRecordCount": 2,
"PageRecordCount": 1,
"PageNumber": 1,
"PageSize": 30,
"TotalPages": 1,
"Items": [
{
"ConsumerId": "c-mqveroemc***",
"Name": "test",
"ConsumerGroupId": "cg-xxxxxx",
"ConsumerTag": "test",
"ApiKey": "xxxxxxxx",
"GwClusterId": "pg-xxxxxxxxxx",
"ApiStatus": "Active",
"ApiKeyStatus": "Active",
"Status": "Enabled",
"GmtCreated": "2024-10-16 16:46:20\n",
"GmtModified": "2026-01-04T16:09:29+08:00",
"Description": "myapp",
"ApiKeyMd5": "0769a11c2d474f96fbb527f8e273d3de",
"BudgetPolicyId": "023aacc1effc4b56bb154bfbec6ba9**",
"BudgetLimit": 3000,
"BudgetUsed": 0,
"ExpireTime": "2025-06-25T09:37:10Z",
"Active": true,
"Expired": false
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。