创建网络接入客户端 - CreateV2AccessClient
功能介绍
创建workspace维度的网络接入客户端,打通用户VPC与AI DataLake服务内网通道。单worksapce最大允许20个网络接入客户端。此接口为同步接口,无配套使用接口和特殊场景。
调用方法
请参见如何调用API。
URI
POST /v2/workspaces/{workspace_id}/access-clients
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 是 | String | 参数解释:工作空间ID,可通过查询工作空间列表获取工作空间ID。 约束限制:不涉及。 取值范围:长度为32~36的英文字符、数字和中划线的组合。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token,通过调用获取IAM用户Token接口获取。 约束限制:不涉及。 取值范围:只能由英文字母、数字及特殊字符组成,长度不超过65534个字符。Token格式由IAM服务定义,具体字符集参见IAM服务相关文档。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释:网络接入客户端名称。 约束限制:不涉及。 取值范围:支持小写字母、数字、中划线,必须字母开头、字母或数字结尾,长度为1~63个字符。 默认取值:不涉及。 |
| vpc_id | 否 | String | 参数解释:虚拟私有云id。 约束限制:不涉及。 取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 |
| subnet_id | 否 | String | 参数解释:子网ID。创建子网时由系统生成。 约束限制:不涉及。 取值范围:长度为36的英文字符、数字和中划线(-)的组合。 默认取值:不涉及。 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释:网络接入客户端ID。 取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。 |
| name | String | 参数解释:网络接入客户端名称。 取值范围:长度为1~64的字符。 |
| status | String | 参数解释:网络接入客户端状态。 取值范围: |
| vpc_id | String | 参数解释:虚拟私有云ID。 取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。 |
| subnet_id | String | 参数解释:子网ID。 取值范围:长度为1~64的英文字符、数字和中划线(-)的组合。 |
| create_time | String | 参数解释:创建时间。 取值范围:不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
请求示例
创建workspace维度的网络接入客户端。
POST /v2/workspaces/{workspace_id}/access-clients
{
"name" : "vpcep-client-001",
"vpc_id" : "050e154d-9954-4929-b6d3-12af7c9213ac",
"subnet_id" : "0d86d58d-d864-47ce-8dbd-5487ff1d59ba"
} 响应示例
状态码:202
{
"id" : "f7670aea-36a1-4bdf-ae99-963c33324370",
"name" : "vpcep-client-001",
"status" : "CREATING",
"vpc_id" : "050e154d-9954-4929-b6d3-12af7c9213ac",
"subnet_id" : "0d86d58d-d864-47ce-8dbd-5487ff1d59ba",
"create_time" : "2026-09-30T10:00:00.000+00:00"
} 状态码:400
{
"error_code" : "AIDataLake.00010151",
"error_msg" : "Parameter value is invalid.",
"solution_msg" : "Please input valid parameter value."
} 状态码:404
{
"error_code" : "AIDataLake.00010009",
"error_msg" : "No resources found.",
"solution_msg" : "Ensure the requested resource exists and the parameters are correct."
} 状态码:500
{
"error_code" : "AIDataLake.00011001",
"error_msg" : "Internal error.",
"solution_msg" : "Contact technical support or try again later."
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | 请求成功,异步创建中。 |
| 400 | 请求参数错误。 |
| 404 | 资源未找到。 |
| 500 | 内部服务器错误。 |