MoveResourceGroup - 修改实例资源组

更新时间:
复制 MD 格式

修改实例所属资源组。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:MoveResourceGroup

none

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

无 无

请求语法

PATCH /openapi/instances/{InstanceId}/resourcegroup HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID。

es-cn-n6w1o1x0w001c****

请求参数

名称

类型

必填

描述

示例值

clientToken

string

否

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

5A2CFF0E-5718-45B5-9D4D-70B3FF****

body

string

否

目标资源组 ID 等实例迁移信息。

{"resourceGroupId":"rg-acfm2h5vbzd****"}

RequestBody

RequestBody 中还需填入以下参数,用来指定将实例迁移到的资源组信息。 | 名称 | 类型 | 是否必选 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | |resourceGroupId| String | 是 | rg-acfm2h5vbzd**** |目标资源组 ID。可在资源组页面获取。|

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

Result

object

返回结果。

nodeAmount

integer

实例的数据节点数量。

2

publicDomain

string

公网访问地址。

es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com

createdAt

string

实例创建时间。格式为 YYYY-MM-DDTHH:mm:ss.SSSZ,末尾 Z 表示 UTC。

2020-07-06T10:18:48.662Z

status

string

实例的状态。支持:

  • active:正常

  • activating:生效中

  • inactive:冻结

  • invalid:失效

active

publicPort

integer

公网端口。

9200

kibanaPort

integer

Kibana 公网端口。

5601

paymentType

string

实例的付费方式。支持:

  • prepaid:包年包月

  • postpaid:按量付费

postpaid

domain

string

实例的内网访问地址。

es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com

description

string

实例名称。

es-cn-abc

esVersion

string

实例版本。

6.7.0_with_X-Pack

kibanaDomain

string

Kibana 公网访问地址。

es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com

updatedAt

string

实例最后更新时间。格式为 YYYY-MM-DDTHH:mm:ss.SSSZ,末尾 Z 表示 UTC。

2018-07-18T10:10:04.484Z

instanceId

string

实例 ID。

es-cn-n6w1o1x0w001c****

dictList

array<object>

IK 词典配置。

object

fileSize

integer

词典文件大小,单位:字节。

2782602

sourceType

string

来源类型,支持:

  • OSS:OSS 开放存储(需要确保 OSS 存储空间为公共可读)

  • ORIGIN:保留之前已经上传的词典

ORIGIN

name

string

词典文件名称。

SYSTEM_MAIN.dic

type

string

词典类型,支持:

  • STOP:停用词

  • MAIN:主词典

  • SYNONYMS:同义词词典

  • ALI_WS:阿里词典

MAIN

synonymsDicts

array<object>

同义词词典配置。

object

fileSize

integer

词典文件大小,单位:字节。

2782602

sourceType

string

来源类型,支持:

  • OSS:OSS 开放存储(需要确保 OSS 存储空间为公共可读)

  • ORIGIN:保留之前已经上传的词典

ORIGIN

name

string

词典文件名称。

SYSTEM_MAIN.dic

type

string

词典类型,支持:

  • STOP:停用词

  • MAIN:主词典

  • SYNONYMS:同义词词典

  • ALI_WS:阿里词典

STOP

nodeSpec

object

数据节点配置信息。

spec

string

节点规格。

elasticsearch.n4.small

disk

integer

节点的存储空间大小,单位:GB。

50

diskType

string

节点的存储类型。

cloud_ssd

networkConfig

object

网络配置。

vpcId

string

专有网络 ID。

vpc-bp16k1dvzxtmagcva****

vsArea

string

实例所在的可用区。

cn-hangzhou-i

type

string

网络类型,只支持专有网络。

vpc

vswitchId

string

虚拟交换机 ID。

vsw-bp1k4ec6s7sjdbudw****

kibanaConfiguration

object

Kibana 节点配置。

spec

string

节点规格。

elasticsearch.n4.small

amount

integer

节点数量。

1

disk

integer

节点存储空间大小,单位:GB。

20

diskType

string

节点存储类型。

cloud_ssd

masterConfiguration

object

Master 节点配置。

spec

string

节点规格。

elasticsearch.sn2ne.large

amount

integer

节点数量。

3

disk

integer

节点存储空间大小,单位:GB。

20

diskType

string

节点存储类型。

cloud_ssd

示例

正常返回示例

JSON格式

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***",
  "Result": {
    "nodeAmount": 2,
    "publicDomain": "es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com",
    "createdAt": "2020-07-06T10:18:48.662Z",
    "status": "active",
    "publicPort": 9200,
    "kibanaPort": 5601,
    "paymentType": "postpaid",
    "domain": "es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com",
    "description": "es-cn-abc",
    "esVersion": "6.7.0_with_X-Pack",
    "kibanaDomain": "es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com",
    "updatedAt": "2018-07-18T10:10:04.484Z",
    "instanceId": "es-cn-n6w1o1x0w001c****",
    "dictList": [
      {
        "fileSize": 2782602,
        "sourceType": "ORIGIN",
        "name": "SYSTEM_MAIN.dic",
        "type": "MAIN"
      }
    ],
    "synonymsDicts": [
      {
        "fileSize": 2782602,
        "sourceType": "ORIGIN",
        "name": "SYSTEM_MAIN.dic",
        "type": "STOP"
      }
    ],
    "nodeSpec": {
      "spec": "elasticsearch.n4.small",
      "disk": 50,
      "diskType": "cloud_ssd"
    },
    "networkConfig": {
      "vpcId": "vpc-bp16k1dvzxtmagcva****",
      "vsArea": "cn-hangzhou-i",
      "type": "vpc",
      "vswitchId": "vsw-bp1k4ec6s7sjdbudw****"
    },
    "kibanaConfiguration": {
      "spec": "elasticsearch.n4.small",
      "amount": 1,
      "disk": 20,
      "diskType": "cloud_ssd"
    },
    "masterConfiguration": {
      "spec": "elasticsearch.sn2ne.large",
      "amount": 3,
      "disk": 20,
      "diskType": "cloud_ssd"
    }
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InstanceActivating Instance is activating
400 InstanceNotFound The instanceId provided does not exist

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

变更历史

更多信息,参考变更详情。