根據執行個體名稱更新執行個體資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
opensearch:WriteFunction |
update |
*FunctionInstance
|
無 | 無 |
請求文法
PUT /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName} HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| appGroupIdentity |
string |
是 |
opensearch 應用程式名稱 |
"app_group_name" |
| functionName |
string |
是 |
功能名稱 |
"ctr" |
| instanceName |
string |
是 |
執行個體名稱 |
"ctr_test" |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Body |
object |
否 |
body 參數 |
{} |
| cron |
string |
否 |
周期訓練資訊,cron 文法(Minutes Hours DayofMonth Month DayofWeek),為空白表示不進行周期訓練(預設),其中 DayofWeek 為 0 表示星期日 |
"0 3 ? * 0,1,3,5" |
| createParameters |
array<object> |
否 |
建立參數列表 |
{ "name": "title_field", "value": "title" } |
|
object |
否 |
參數體 |
{} |
|
| name |
string |
否 |
參數名稱 |
title_field |
| value |
string |
否 |
參數值 |
title |
| usageParameters |
array<object> |
否 |
使用參數列表 |
|
|
object |
否 |
參數體 |
||
| name |
string |
否 |
參數名稱 |
allow_dict_id |
| value |
string |
否 |
參數值 |
123 |
| description |
string |
否 |
執行個體描述 |
測試執行個體 |
樣本(只更新 createParameters 和 cron)
PUT /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test
{
"createParameters": [
{
"name": "param1",
"value": "new value"
}
],
"cron": ""
}
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
{} |
|
| Status |
string |
請求狀態
|
OK |
| HttpCode |
integer |
http 狀態代碼 |
200 |
| RequestId |
string |
請求 id |
"3A809095-C554-5CF5-8FCE-BE19D4673790" |
| Message |
string |
錯誤資訊 |
"instance not exist." |
| Code |
string |
錯誤碼 |
"Instance.NotExist" |
| Latency |
integer |
請求耗時(單位 ms) |
10 |
樣本
正常返回樣本
JSON格式
{
"Status": "OK",
"HttpCode": 200,
"RequestId": "\"3A809095-C554-5CF5-8FCE-BE19D4673790\"",
"Message": "\"instance not exist.\"",
"Code": "\"Instance.NotExist\"",
"Latency": 10
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。