接口功能介绍

创建的云专线(Cloud Dedicated Access)网关。

接口约束

无

URI

POST /v4/cda/gateway/add

路径参数

无

Query 参数

无

请求参数

请求头 header 参数

无

请求体 body 参数

参数	是否必填	参数类型	说明	示例
displayName	是	String	专线网关名字
account	是	String	天翼云客户邮箱	user@sample.com
resourcePool	是	String	资源池ID
resourcePoolName	是	String	资源池名字
hostname	是	String	交换机hostname
isSwConfig	否	Boolean	是否下发配置到交换机，默认true
description	否	String

响应参数

参数	参数类型	描述	下级对象
statusCode	Integer	返回状态码(800为成功，900为失败)
message	String	失败时的错误描述，一般为英文描述
description	String	失败时的错误描述，一般为中文描述
returnObj	Object	返回对象	returnObj
errorCode	String	业务细分码，为product.module.code三段式码

表returnObj

参数	参数类型	说明
result	String	1成功， 0失败
data	String	成功为null
errorMsg	String	成功为null
errorCode	String	成功为null
traceID	String	日志跟踪ID

请求示例

请求头

无

请求体 body

{
    "displayName": "nm8CTYUN20",
    "account": "autotest0627@qq.com",
    "resourcePool": "81f7728662dd11ec810800155d307d5b",
    "resourcePoolName": "内蒙演示环境",
    "accessPoint": "AP1",
    "hostName": "NMA07-405-H12-ASW-RG6250-1U37",
    "description": ""
}

响应示例

{
	"returnObj": {
	    "traceID": "f013a88450314fc19988eaff44bd6177",
		"errorCode": null,
		"errorMsg": null,
		"data": null,
		"result": "1"
	},
	"errorCode": "",
	"message": "",
	"description": "",
	"statusCode": 800
}

状态码

状态码	描述
800	表示请求成功
900	表示请求未成功

错误码

errorCode	描述
OPENAPI.PatternCheck.NotValid	请求参数无效
OPENAPI.CDA.AccessFailed	内部错误，请重试。如果多次尝试失败，请提交工单

云专线

专线网关创建