修改指定实例配置。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:UpdateInstance | update |
|
| 无 |
请求语法
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 | 否 | 实例描述信息。 | 实例描述 |
返回参数
示例
正常返回示例
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"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-02 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-01-12 | 新增 OpenAPI | 查看变更详情 |
示例
请求示例
PUT /openapi/ha3/instances/ha-cn-xxxxxx
{
"description": "the new description"
}
或
{
"resourceGroupId": "the new resourceGroupId"
}
返回示例
正确返回
{
"result": {
"instanceId": "ha-cn-pl32rf0****",
"description": "测试实例",
"status": "Running",
"chargeType": "POSTPAY",
"commodityCode": "opensearch_ha3post_public_cn",
"createTime": "2018-12-06T11:17:49.0",
"updateTime": "2018-12-06T11:17:49.0",
"expiredTime": "2019-01-06T16:00:00.0",
"resourceGroupId": "rg-abcdefg",
"lockMode": "Unlock",
"inDebt": false,
"spec": {
"password": "passwd",
"searchResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"instanceName": "ha-cn-pl32rf0****",
"vSwitchId": "vswitch_id_xxx",
"vpcId": "vpc_id_xxx",
"qrsResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"region": "cn-hangzhou",
"userName": "user"
},
"status": {
"phase": "PENDING",
"instancePhase": "INIT",
"createSuccess": false
}
},
"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}
详情可参考响应结构