创建vpn授权
接口功能介绍
创建vpn授权,由vpn创建者授权给其他用户(被授权租户),授权后被授权租户可以访问此vpn的资源。
接口约束
创建授权时,仅支持对未加入云间高速的vpn进行授权,否则会存在vpn查询不到的情况。如果需要操作授权,请先将vpn从云间高速删除。
URI
POST /v4/ec/auth-vpn/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vpnID | 是 | String | vpn唯一ID | vrf-55450584 | |
vpnName | 是 | String | 云间高速侧显示的vpn名称(建议保持和vpn创建时的名称一致) | 北京cda-1 | |
是 | String | 当前用户邮箱(邮箱不准确可能导致授权实例无法加载) | email@189.com | ||
authTenantID | 是 | String | 被授权用户唯一ID | 35550584-fe8f-49b0-9e09-ef915caeee10 | |
authEcID | 是 | String | 被授权用户云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
dcID | 是 | String | 资源池ID信息 | 81f7728662dd11ec810800155d307d5b | |
authDescription | 否 | String | 描述信息 | crossnetwork description |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
returnObj | 否 | object | 返回参数 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
authID | 否 | String | 账号授权ID | 3e4a0584-fe8f-49b0-9e09-ef915caeee10 | |
createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 |
请求示例
请求url
无
请求头header
无
请求体body
{
"vpnID": "afefa-efesf-5450584",
"vpnName": "北京test1",
"email": "mail001@189.com",
"authTenantID": "35550584-fe8f-49b0-9e09-ef915caeee10",
"authEcID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"dcID": "81f7728662dd11ec810800155d307d5b",
"authDescription": "内蒙测试"
}
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"bc9a70eb-28d7-4032-9510-1bea00192f34",
"returnObj":
{
"authID": "3e4a0584-fe8f-49b0-9e09-ef915caeee10",
"createDate": "2022-09-19 02:05:28"
}
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.AuthorizeEc.CreateError | 内部错误,请重试。如果多次尝试失败,请提交工单 |