修改私有网络描述--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

修改私有网络描述

最近更新时间：2024.07.18 11:03:31首次发布时间：2022.02.25 18:58:32

本接口用于修改私有网络的描述。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
vpc_identity	String	是	`vpc-sbjngs****`	私有网络的 ID。
desc	String	是	`test`	私有网络的描述。您最多可以输入80个字符。如果不指定该参数或参数值为空字符串，原来的描述将被清空。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetVPCInstanceDesc&Version=2021-04-30
&<其他公共参数>
{
    "vpc_identity": "vpc-sbjngs****",
    "desc": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230522170831545A9EDEF8991C90****",
        "Action": "SetVPCInstanceDesc",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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