修改子网名称和描述--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

修改子网名称和描述

最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 18:00:51

本接口用于修改子网的名称和描述。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=SetSubnetNameAndDesc&Version=2021-04-30

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`SetSubnetNameAndDesc`	接口名称。当前 API 的名称为 `SetSubnetNameAndDesc`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

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

subnet_identity String 是 subnet-q6b7krwdfrg**** 子网的 ID。

参数	类型	是否必选	示例值	描述
subnet_identity	String	是	`subnet-q6b7krwdfrg****`	子网的 ID。
name	String	否	`subnet-dev`	子网的名称。命名规则如下：允许 5~50 个字符。支持汉字、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
desc	String	否	`subnet-dev`	子网的描述。

name

String

否

subnet-dev

子网的名称。命名规则如下：

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

desc String 否 subnet-dev 子网的描述。

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetSubnetNameAndDesc&Version=2021-04-30
{
    "subnet_identity": "subnet-q6b7krwdfrg****",
    "name": "subnet-dev",
    "desc": "subnet-dev"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024032619553627C26E2CFC20D55E****",
        "Action": "SetSubnetNameAndDesc",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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