按需建立指定應用組的訪問憑據,支援dryRun模式預覽操作。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
opensearch:WriteAppGroupCredential |
create |
*AppGroupCredential
|
無 | 無 |
請求文法
POST /v4/openapi/app-groups/{appGroupIdentity}/credentials HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| appGroupIdentity |
string |
是 |
應用群組識別碼。 |
app_group_123 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| dryRun |
boolean |
否 |
指定此次操作是否為 dry run,即只檢查參數,不實際執行操作。 |
|
| body |
object |
否 |
請求體,包含憑據類型等資訊。 |
|
| type |
string |
否 |
憑據類型,如 api-key、account、invoke-key 或 api-token。建立 api-key 時寫為 api-token。 |
api-token |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
成功響應的結構。 |
||
| requestId |
string |
請求唯一標識。 |
1-2-3-4 |
| result |
object |
操作結果詳情。 |
|
| appGroupId |
integer |
應用組 ID。 |
app_group_123 |
| type |
string |
憑據類型。 |
api-token |
| enabled |
boolean |
憑據是否啟用。 |
|
| token |
string |
產生的憑據令牌。 |
generated_token_string |
樣本
正常返回樣本
JSON格式
{
"requestId": "1-2-3-4",
"result": {
"appGroupId": 0,
"type": "api-token",
"enabled": true,
"token": "generated_token_string"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。