You need to enable JavaScript to run this app.
导航
专线连接
  • 文档首页
    • /
  • 专线连接

CreateDirectConnectGateway

最近更新时间：2024.04.18 19:01:50

首次发布时间：2022.03.25 07:38:20

我的收藏

调用CreateDirectConnectGateway创建一个专线网关。

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是CreateDirectConnectGateway要执行的操作，取值：CreateDirectConnectGateway。
VersionString是2020-04-01API版本信息。

DirectConnectGatewayName

String

否

test

专线网关的名称。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短横线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不传入该参数或该参数不传入数值时，默认为专线网关的ID。

Description

String

否

This is a sample description

专线网关的描述信息。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。

ClientToken

String

否

123e4567-e89b-12d3-a456-42665544****

客户端Token，用于保证请求幂等性。

  • 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 仅支持ASCII字符，且不能超过64个字符。
  • 若不传入ClientToken，则此次API调用不进行幂等校验。

EnableIpv6

Boolean

否

false

是否启用IPv6。

  • true：启用
  • false：不启用。

Tags.N.Key

String

否

Tags.1.Key=key1&Tags.2.Key=key2&Tags.3.Key=key3

专线网关标签的标签键（Key）。

  • 参数 - N - 参数：表示标签键（Key）的序号，取值范围：1、2、3、……、49、50，且N应按照连续的从小到大的顺序。
  • 多个标签键（Key）之间用&分隔。
  • 不能以 volc:和sys:开头，包括任意大小写形式。volc:和sys:开头为系统预留标签，禁止创建。
  • 长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。

Tags.N.Value

String

否

Tags.1.Value=value1&Tags.2.Value=value2&Tags.3.Value=value3

专线网关标签的标签值（Value）。

  • 参数 - N - 参数：表示标签值（Value）的序号，取值范围：1、2、3、……、49、50，且N应按照连续的从小到大的顺序。
  • 多个标签值（Value）之间用&分隔。
  • 长度取值范围为0～256字符，不填默认为空。
  • 允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。
  • 大小写敏感，不能以空格开头或结尾。

说明

传入Tags.N.Value则必须传入Tags.N.Key。

返回数据

名称类型
示例值
描述
RequestIdString202111161611080102121461940900****请求ID。
DirectConnectGatewayIdStringdcg-7qthudw0ll6jmc****新创建专线网关的ID。

请求示例

GET /?Action=CreateDirectConnectGateway&Version=2020-04-01&DirectConnectGatewayName=test&Description=test HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202111161611080102121461940900****",
        "Action": "CreateDirectConnectGateway",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202111161611080102121461940900****",
        "DirectConnectGatewayId": "dcg-7qthudw0ll6jmc****"
    }
}

错误码

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

HttpCode
错误码
错误信息
描述
400PreOrderErrorFailed to create preorder for direct connect gateway.创建专线网关配置单失败。
400UnsupportedOperationThe request on the specified instance is denied due to the account in arrears status.因账户处于欠费状态，对于该实例的操作请求被拒绝。
400UnsupportedOperationThe request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total.因账户余额及可用代金券共不足100元，对于该实例的操作请求被拒绝。
400OrderErrorFailed to create an order for direct connect gateway in one step.创建专线网关订单并支付失败。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400QuotaExceeded.DirectConnectGatewayYou've reached the limit on the number of direct connect gateways that you can create.已达到可创建的专线网关的数量上限。
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidTagKey.MalformedThe specified parameter tag key is invalid.标签键不合法。
400InvalidTagValue.MalformedThe specified parameter tag value is invalid.标签值不合法。
400LimitExceeded.TagsYou've reached the limit on the number of tags that you can operate at one time.已达到单次可操作标签数量的上限。
400InvalidTag.DisorderThe specified index order of tag is malformed.指定标签的索引顺序参数格式不合法。
403Forbidden.IPv6You are not authorized to operate IPv6 functions.无权限操作IPv6功能。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。