You need to enable JavaScript to run this app.
导航
云搜索服务
  • 文档首页
    • /
  • 云搜索服务

RenameInstance - 修改实例名称

最近更新时间：2024.04.09 15:04:00

首次发布时间：2023.11.30 14:19:27

我的收藏

调用 RenameInstance 接口，修改目标实例名称。

请求说明

  • 请求方式：POST
  • 请求地址：/?Action=RenameInstance&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数类型是否必选示例值描述
ActionString是RenameInstance接口名称。当前 API 的名称为 RenameInstance。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述

NewName

String

是

doc-test-1

自定义设置实例新名称。

  • 只能包含中文、字母、数字、短横线（-）和下划线（_），开头和结尾不能是数字和短横线（-）。
  • 长度在 1～128 个字符内。
InstanceIdString是o-00k0***o718需要修改名称的实例 ID。

返回参数

参数类型示例值描述
StatusStringSUCCESSFUL返回的操作状态。
MessageString--返回的提示信息。

请求示例

POST https://open.volcengineapi.com/?Action=RenameInstance&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "InstanceId": "o-00k0***o718",
    "NewName": "doc-test-1"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "RenameInstance",
        "Region": "cn-beijing",
        "RequestId": "2023060411042001001002322800**",
        "Service": "escloud",
        "Version": "2023-01-01"
    },
    "Result": {
        "Status": "SUCCESSFUL",
        "Message": ""
    }
}