修改指定实例配置。
接口说明
方法
PUT
URI
/openapi/ha3/instances/{instanceId}
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
searchengine:UpdateInstance |
update |
*Instance
|
无 | 无 |
请求语法
PUT /openapi/ha3/instances/{instanceId} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
否 |
实例 id |
ha-cn-pl32rf0**** |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求结构。 |
{} |
| components |
array<object> |
否 |
实例相关的规格信息列表。 |
|
|
object |
否 |
实例相关的规格信息 |
||
| code |
string |
否 |
规格 code，和售卖参数保持一致 |
searcherdocsizesum |
| value |
string |
否 |
值 |
200 |
| orderType |
string |
否 |
UPGRAGE： 提升实例规格 DOWNGRADE: 降低实例规格 |
UPGRAGE |
| description |
string |
否 |
实例描述信息。 |
实例描述 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| result |
object |
返回结果。 |
|
| description |
string |
实例描述 |
测试实例 |
| resourceGroupId |
string |
资源组 ID |
ha-cn-pl32rf0**** |
| expiredTime |
string |
到期时间 |
2019-01-06T16:00:00.0 |
| commodityCode |
string |
商品 code |
opensearch_ha3post_public_cn |
| status |
string |
状态 |
READY |
| instanceId |
string |
资源一级 ID |
ha-cn-pl32rf0**** |
| createTime |
string |
创建时间 |
2018-12-06T11:17:49.0 |
| lockMode |
string |
锁定状态 |
Unlock |
| chargeType |
string |
付费类型 |
POSTPAY |
| updateTime |
string |
更新时间 |
2018-12-06T11:17:49.0 |
| inDebt |
boolean |
是否欠费 |
false |
| requestId |
string |
请求 ID |
90D6B8F5-FE97-4509-9AAB-367836C51818 |
示例
正常返回示例
JSON格式
{
"result": {
"description": "测试实例",
"resourceGroupId": "ha-cn-pl32rf0****",
"expiredTime": "2019-01-06T16:00:00.0",
"commodityCode": "opensearch_ha3post_public_cn",
"status": "READY",
"instanceId": "ha-cn-pl32rf0****",
"createTime": "2018-12-06T11:17:49.0",
"lockMode": "Unlock",
"chargeType": "POSTPAY",
"updateTime": "2018-12-06T11:17:49.0",
"inDebt": false
},
"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。