文档

UpdateInstance - 修改指定实例配置

更新时间:

修改指定实例配置。

接口说明

方法

PUT

URI

/openapi/ha3/instances/{instanceId}

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:UpdateInstanceWrite
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

PUT /openapi/ha3/instances/{instanceId}

请求参数

名称类型必填描述示例值
instanceIdstring

实例 id

ha-cn-2r42mu9xi01
bodyobject

请求结构。

componentsobject []

实例相关的规格信息列表。

codestring

规格 code,和售卖参数保持一致

200
valuestring

""
orderTypestring

UPGRAGE: 提升实例规格 DOWNGRADE: 降低实例规格

""
descriptionstring

实例描述信息。

""

返回参数

名称类型描述示例值
object

Schema of Response

resultobject

返回结果。

descriptionstring

实例描述

测试实例
resourceGroupIdstring

资源组 ID

rg-aeky6hthboewpuy
expiredTimestring

到期时间

2019-01-06T16:00:00.0
commodityCodestring

商品 code

ha3-code
statusstring

状态

Running
instanceIdstring

资源一级 ID

ha-cn-0ju2s170b03
createTimestring

创建时间

2018-12-06T11:17:49.0
lockModestring

锁定状态

Unlock
chargeTypestring

付费类型

PrePaid
updateTimestring

更新时间

2018-12-06T11:17:49.0
inDebtboolean

是否欠费

false
requestIdstring

请求 ID

90D6B8F5-FE97-4509-9AAB-367836C51818

示例

正常返回示例

JSON格式

{
  "result": {
    "description": "测试实例",
    "resourceGroupId": "rg-aeky6hthboewpuy",
    "expiredTime": "2019-01-06T16:00:00.0",
    "commodityCode": "ha3-code",
    "status": "Running",
    "instanceId": "ha-cn-0ju2s170b03",
    "createTime": "2018-12-06T11:17:49.0",
    "lockMode": "Unlock",
    "chargeType": "PrePaid",
    "updateTime": "2018-12-06T11:17:49.0",
    "inDebt": false
  },
  "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-02API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-01-12新增 OpenAPI看变更集

示例

请求示例

PUT /openapi/ha3/instances/ha-cn-xxxxxx

{
  "description": "the new description"
}
{
  "resourceGroupId": "the new resourceGroupId"
}

返回示例

正确返回

{
  "result": {
    "instanceId": "airec-cn-o400whm78004",
    "description": "airec-cn-o400whm78004",
    "status": "Running",
    "chargeType": "PrePaid",
    "commodityCode": "airecpre",
    "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": "testInstance",
      "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"
}

详情可参考响应结构

  • 本页导读 (0)
文档反馈