RenameInstance - 修改实例名称--云搜索服务-火山引擎

文档中心

立即注册

导航

RenameInstance - 修改实例名称

最近更新时间：2024.10.21 17:11:13首次发布时间：2023.11.30 14:19:27

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	RenameInstance	要执行的操作，取值：RenameInstance。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	`o-00k0***o718`	需要修改名称的实例 ID。
NewName	String	是	`doc-test-1`	自定义设置实例新名称。只能包含中文、字母、数字、短横线（-）和下划线（_），开头和结尾不能是数字和短横线（-）。长度在 1～128 个字符内。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Status	String	`SUCCESSFUL`	返回的操作状态。
Message	String	--	返回的提示信息。

请求示例

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": ""
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InternalServerError	服务器内部异常	服务由于异常退出，无法完成接口请求操作
200	Unauthorized	unauthorized error	用户无权限调用接口
200	IllegalParameter	illegal parameter	非法参数。可能是参数缺失，也可能是参数不符合接口要求