You need to enable JavaScript to run this app.
导航
编辑边缘实例名称
最近更新时间:2023.07.03 16:32:35首次发布时间:2022.02.25 18:58:31

本接口用于设置边缘实例的名称。

请求方法

POST

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

名称

类型

是否必选

示例值

描述

Action

String

SetInstanceName

公共参数。该参数表示接口名称。取值:SetInstanceName。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

instance_identity

String

veen1020125208252511****

边缘实例 ID。您可以通过 ListInstances 接口查询边缘实例 ID。

instance_name

String

foo****

实例名称。命名规则如下:

  • 允许5~80个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。
  • 不能包含双引号(")、反斜线( \)和空格,且不能以正斜线(/)开头。

返回数据


请求示例

POST https://veenedge.volcengineapi.com/?Action=SetInstanceName&Version=2021-04-30
&<其他公共参数>
{
  "instance_identity": "veen2210222221323202****",
  "instance_name": "instance_test01"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230525181544394C26E0F38ADB0E****",
        "Action": "SetInstanceName",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码