ModifyDirectConnectGatewayAttributes--专线连接-火山引擎

文档中心

立即注册

导航

ModifyDirectConnectGatewayAttributes

最近更新时间：2024.04.18 19:01:51首次发布时间：2022.03.25 07:38:20

调用ModifyDirectConnectGatewayAttributes修改指定专线网关的名称、描述信息。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ModifyDirectConnectGatewayAttributes	要执行的操作，取值为ModifyDirectConnectGatewayAttributes。
Version	String	是	2020-04-01	API版本信息。
DirectConnectGatewayId	String	是	dcg-7qthudw0ll6jmc****	待修改信息的专线网关的ID。您可调用DescribeDirectConnectGateways查询专线网关的ID。
DirectConnectGatewayName	String	否	test	专线网关的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不更改该参数时，保持原有配置，表示不修改专线网关的名称。
Description	String	否	This is a sample description	专线网关的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不更改该参数时，保持原有配置，表示不修改专线网关的描述。
EnableIpv6	Boolean	否	false	是否启用IPv6。 true：启用 false：不启用。不更改该参数时，保持原有配置。如果已启用IPv6，不可再修改为不启用。

返回数据

名称	类型	示例值	描述
RequestId	String	202111161611080102121461940900****	请求ID。

请求示例

GET /?Action=ModifyDirectConnectGatewayAttributes&Version=2020-04-01&DirectConnectGatewayId=dcg-7qthudw0ll6jmc****&DirectConnectGatewayName=test&Description=test HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202111161611080102121461940900****",
        "Action": "ModifyDirectConnectGatewayAttributes",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
    		"RequestId": "202111161611080102121461940900****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDirectConnectGateway.InvalidStatus	The specified direct connect gateway is not in the correct status for the request.	指定的专线网关所处的状态无法响应该请求。
400	InvalidDirectConnectGateway.InvalidBusinessStatus	The specified direct connect gateway is not in the correct status for the request. The specified direct connect gateway is in freeze.	指定的专线网关所处的状态无法响应该请求。当前专线网关被冻结。
400	InvalidDirectConnectGateway.DisableIPv6	The specified direct connect gateway does not support disabling IPv6.	指定的专线网关不支持禁用IPv6。
403	Forbidden.IPv6	You are not authorized to operate IPv6 functions.	无权限操作IPv6功能。
404	InvalidDirectConnectGateway.NotFound	The specified direct connect gateway does not exist.	指定的专线网关不存在。