创建内网接入 - CreateV2IntranetConnection
功能介绍
本接口用于在指定Region中创建内网接入点,适用于需要为应用程序或服务配置内网连接的场景。调用此接口前,确保已具备相应的创建权限,并提供必要的参数,如Region ID、内网接入点名称和网络配置信息。创建成功后,系统将生成一个内网接入点,并返回该接入点的详细信息,包括接入点ID、创建时间、状态等。如果提供的参数无效或内网接入配置冲突,将返回相应的异常信息,提示用户检查输入数据的有效性和配置冲突情况。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts::createIntranetConnection
Write
-
-
modelarts:intranetConnection:create
-
URI
POST /v2/{project_id}/intranet-connection
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| x-auth-token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| service_id | 否 | String | 参数解释: 服务ID,在创建服务时即可在返回体中获取,也可通过查询服务列表获取当前用户拥有的服务,其中service_id字段即为服务ID。 约束限制: type为SERVICE时,必填。 取值范围: 不涉及。 默认取值: 不涉及。 |
| scene | 是 | String | 参数解释: 内网访问场景。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| vpc_id | 否 | String | 参数解释: VPC ID,VPC场景需要填写。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| subnet_id | 否 | String | 参数解释: 子网 ID,VPC场景需要填写。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| pool_id | 否 | String | 参数解释: 资源池id POOL场景需要填写。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| type | 否 | String | 参数解释: 内网访问接入粒度,不填默认为SERVICE 约束限制: 不涉及。 取值范围: 默认取值: 默认为SERVICE。 |
| dispatcher_group_id | 否 | String | 参数解释: 服务绑定的dispatcher组ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| custom_urls | 否 | Array of strings | 参数解释: 自定义URL,格式为:{协议}://{域名}{路径} 约束限制: url个数不超过10个,单个url长度不超过1024。 取值范围: 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| applicant_user_name | String | 参数解释: 申请方用户名。 取值范围: 不涉及。 |
| id | String | 参数解释: 内网接入id。 取值范围: 不涉及。 |
| message | String | 参数解释: 申请描述。 取值范围: 不涉及。 |
| owner_domain_name | String | 参数解释: 审核方domain name。 取值范围: 不涉及。 |
| scene | String | 参数解释: 内网访问场景。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| service_id | String | 参数解释: 服务ID。 取值范围: 不涉及。 |
| service_name | String | 参数解释: 服务名。 取值范围: 不涉及。 |
| status | String | 参数解释: 内网接入状态,支持列表查询。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| subnet_id | String | 参数解释: 子网ID。 取值范围: 不涉及。 |
| url_list | Array of strings | 参数解释: 访问地址列表。 |
| custom_url_list | Array of strings | 参数解释: 访问地址列表。 |
| vpc_id | String | 参数解释: VPC ID。 取值范围: 不涉及。 |
| dispatcher_group_id | String | 参数解释: 服务绑定的dispatcher组ID。 取值范围: 不涉及。 |
| type | String | 参数解释: 接入粒度:SERVICE、GLOBAL 取值范围: 不涉及。 |
| service_type | String | 参数解释: 服务类型。 取值范围: 不涉及。 |
| pool_id | String | 参数解释: 资源池ID。 取值范围: 不涉及。 |
| create_at | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| update_at | String | 参数解释: 修改时间。 取值范围: 不涉及。 |
请求示例
http://127.0.0.1:8443/v2/{project_id}/intranet-connection
{
"service_id" : "e78773fa-4b27-446e-801d-****example",
"scene" : "vpc",
"vpc_id" : "15e04c58-45df-44ee-8b5c-****example",
"subnet_id" : "339e64b8-ec66-4a08-b710-****example"
} 响应示例
状态码:200
内网接入信息。
{
"applicant_user_name" : "user_name****example",
"dispatcher_group_id" : "ca29ce14-b475-4bee-93b4****example",
"id" : "566149dd-d0ce-43e6-9f2d-57608a36de80",
"owner_domain_name" : "domain_name****example",
"scene" : "VPC",
"service_id" : "e78773fa-4b27-446e-801d-4****example",
"service_name" : "service-ll-722-10",
"status" : "CONNECTING",
"subnet_id" : "339e64b8-ec66-4a08-b710-c****example",
"type" : "SERVICE",
"vpc_id" : "15e04c58-45df-44ee-8b5c-****example"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 内网接入信息。 |
错误码
请参见错误码。