创建网络资源 - CreateNetwork
功能介绍
创建网络资源接口用于在系统中创建新的网络资源。该接口适用于以下场景:当需要为业务扩展、资源规划或网络架构调整时,用户可通过此接口创建新的网络资源,如虚拟网络、子网或路由等。使用该接口的前提条件是用户具有管理员权限,并且系统中具备足够的资源支持新网络资源的创建。创建操作完成后,新的网络资源将被成功添加到系统中,并可用于后续的业务配置。若用户无权限、资源不足或输入参数有误,接口将返回相应的错误信息。
接口约束
网络资源的创建是一个异步过程,需要等待网络状态正常后方可正常使用。使用非正常状态下的网络创建资源池,系统会报错。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1/{project_id}/networks
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| apiVersion | 是 | String | 参数解释:API版本。 约束限制:不涉及。 取值范围:可选值如下: 默认取值:不涉及。 |
| kind | 是 | String | 参数解释:资源类型。 约束限制:不涉及。 取值范围:可选值如下: 默认取值:不涉及。 |
| metadata | 是 | NetworkMetadataCreation object | 参数解释:网络资源的metadata信息。 约束限制:不涉及。 |
| spec | 是 | NetworkSpecCreation object | 参数解释:网络资源的描述信息。 约束限制:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| labels | 是 | NetworkMetadataLabels object | 参数解释:网络资源的标签信息。 约束限制:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| os.modelarts/name | 是 | String | 参数解释:用户指定的network名称。 取值范围:只能以小写字母开头,数字、中划线组成,不能以中划线结尾,且长度为4-32。 |
| os.modelarts/workspace.id | 否 | String | 参数解释:工作空间ID。获取方法请参见查询工作空间列表。 取值范围:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ipv6enable | 否 | Boolean | 参数解释:是否启用ipv6,一旦开启,将不能关闭。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| cidr | 是 | String | 参数解释:网络的cidr。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围: 默认取值:不涉及。 |
| extendCidrs | 否 | Array of strings | 参数解释:扩展网段列表,主网段IP不足时可添加扩展网段扩充MA网段。 约束限制:最多5个;仅支持IPv4;掩码范围为3~28;不能与主网段、预留网段及其他扩展网段重叠。 取值范围:不涉及。 默认取值:不涉及。 |
| subnets | 否 | Array of Subnet objects | 参数解释:子网列表。创建时若未指定,系统默认以网络的cidr生成名为default-subnet的子网。 约束限制:子网名称不能重复;每个子网的cidr必须包含在网络cidr或某个扩展网段内,且子网间cidr不能重叠;至少包含一个普通子网。 取值范围:不涉及。 默认取值:不涉及。 |
| expressGateway | 否 | ExpressGateway object | 参数解释:网络是否开启ExpressGateway能力。 约束限制:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| apiVersion | String | 参数解释:API版本。 取值范围:可选值如下: |
| kind | String | 参数解释:资源类型。 取值范围:可选值如下: |
| metadata | NetworkMetadata object | 参数解释:网络资源的metadata信息。 |
| spec | NetworkSpec object | 参数解释:网络资源的描述信息。 |
| status | NetworkStatus object | 参数解释:网络资源的状态信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释:系统自动生成的network名称,相当于networkId。 取值范围:不涉及。 |
| creationTimestamp | String | 参数解释:时间戳,"2021-11-01T03:49:41Z"。 取值范围:不涉及。 |
| deletionTimestamp | String | 参数解释:网络的删除时间。例如"2025-12-01T03:49:41Z"。 取值范围:不涉及。 |
| labels | NetworkMetadataLabels object | 参数解释:网络资源的标签信息。 |
| annotations | NetworkMetadataAnnotations object | 参数解释:网络资源的注释信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| os.modelarts/name | String | 参数解释:用户指定的network名称。 取值范围:只能以小写字母开头,数字、中划线组成,不能以中划线结尾,且长度为4-32。 |
| os.modelarts/workspace.id | String | 参数解释:工作空间ID。获取方法请参见查询工作空间列表。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| os.modelarts/description | String | 参数解释:网络的描述信息。 取值范围:不能包含字符!<>=&"'。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| ipv6enable | Boolean | 参数解释:是否启用ipv6,一旦开启,将不能关闭。 取值范围:不涉及。 |
| cidr | String | 参数解释:网络的cidr。 取值范围:不涉及。 |
| extendCidrs | Array of strings | 参数解释:扩展网段列表,主网段IP不足时可添加扩展网段扩充MA网段。 取值范围:不涉及。 |
| subnets | Array of Subnet objects | 参数解释:子网列表。更新时支持新增或删除子网,删除的子网需未被任何资源使用。 取值范围:不涉及。 |
| expressGateway | ExpressGateway object | 参数解释:网络是否开启ExpressGateway能力。 |
| connection | NetworkConnection object | 参数解释:当前网络与其他云服务的连通信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cidr | String | 参数解释:子网的cidr。 取值范围:不涉及。 |
| name | String | 参数解释:子网的名称。 取值范围:不涉及。 |
| type | String | 参数解释:子网类型。 取值范围:可选值如下: |
| remark | String | 参数解释:子网的备注信息,用于描述子网的使用场景。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| peerConnectionList | Array of PeerConnectionItem objects | 参数解释:Peer方式打通网络列表。 |
| sfsTurboConnectionList | Array of SfsTurboConnectionItem objects | 参数解释:挂载网卡方式打通sfsturbo列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| peerVpcId | String | 参数解释:对端的VPC ID。 取值范围:不涉及。 |
| peerSubnetId | String | 参数解释:对端的子网ID。 取值范围:不涉及。 |
| defaultGateWay | Boolean | 参数解释:创建默认路由的开关,默认为false不创建。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释:sfsTurbo实例的名称。 取值范围:不涉及。 |
| sfsId | String | 参数解释:sfsTurbo实例的ID。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 参数解释:网络的当前状态。 取值范围:可选值如下: |
| message | String | 参数解释:网络异常原因的描述信息。 取值范围:不涉及。 |
| ipv6enable | Boolean | 参数解释:网络是否已启用ipv6。 取值范围:不涉及。 |
| vpcId | String | 参数解释:网络对应的VPC ID。 取值范围:不涉及。 |
| extendCidrs | Array of strings | 参数解释:已添加的扩展网段列表。 取值范围:不涉及。 |
| subnets | Array of SubnetStatus objects | 参数解释:网络中子网的状态信息列表。 |
| expressGateway | ExpressGatewayStatus object | 参数解释:网络ExpressGateway的状态信息。 |
| connectionStatus | NetworkConnectionStatus object | 参数解释:网络与其他云服务连通状态信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cidr | String | 参数解释:子网的cidr。 取值范围:不涉及。 |
| name | String | 参数解释:子网的名称。 取值范围:不涉及。 |
| type | String | 参数解释:子网类型。 取值范围:可选值如下: |
| remark | String | 参数解释:子网的备注信息。 取值范围:不涉及。 |
| networkId | String | 参数解释:子网对应的network ID,取值可用于查询网络可用IP数量(network_id参数)。 取值范围:不涉及。 |
| state | String | 参数解释:子网的当前状态。 取值范围:可选值如下: |
| message | String | 参数解释:子网状态异常时的原因描述。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释:ExpressGateway的当前状态。 取值范围:可选值如下: |
| message | String | 参数解释:ExpressGateway状态异常时的原因描述。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| peerConnectionStatus | Array of PeerConnectionStatus objects | 参数解释:Peer方式打通网络的状态信息列表。 |
| sfsTurboStatus | Array of SfsTurboConnectionStatus objects | 参数解释:网络可连通的SFS Turbo信息列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| peerVpcId | String | 参数解释:对端的VPC ID。 取值范围:不涉及。 |
| peerSubnetId | String | 参数解释:对端的子网ID。 取值范围:不涉及。 |
| defaultGateWay | Boolean | 参数解释: 创建默认路由的开关,默认为false不创建。 取值范围:不涉及。 |
| phase | String | 参数解释:网络的连接状态。 取值范围:可选值如下: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释:sfsTurbo实例的名称。 取值范围:不涉及。 |
| sfsId | String | 参数解释:sfsTurbo实例的ID。 取值范围:不涉及。 |
| connectionType | String | 参数解释:关联方式。 取值范围:可选值如下: |
| ipAddr | String | 参数解释:SFS Turbo的访问地址。 取值范围:不涉及。 |
| status | String | 参数解释:与SFS Turbo的连接状态信息。 取值范围:可选值如下: |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:ModelArts错误码。 取值范围:不涉及。 |
| error_msg | String | 参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
创建网络。设置资源类型为“Network”,用户指定的network名称为“network-7a03”,网络的cidr为“192.168.128.0/17”。
POST {endpoint}/v1/{project_id}/networks
{
"apiVersion" : "v1",
"kind" : "Network",
"metadata" : {
"labels" : {
"os.modelarts/name" : "network-7a03",
"os.modelarts/workspace.id" : "0"
}
},
"spec" : {
"cidr" : "192.168.128.0/17"
}
} 响应示例
状态码:200
{
"kind" : "Network",
"apiVersion" : "v1",
"metadata" : {
"name" : "network-7a03-86c13962597848eeb29c5861153a391f",
"creationTimestamp" : "2022-09-16T09:44:59Z",
"labels" : {
"os.modelarts/name" : "network-7a03",
"os.modelarts/workspace.id" : "0"
},
"annotations" : { }
},
"spec" : {
"cidr" : "192.168.128.0/17",
"connection" : { }
},
"status" : {
"phase" : "Creating"
}
} 状态码:400
{
"error_code" : "ModelArts.50004000",
"error_msg" : "Bad request."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 400 | Bad Request。 |
错误码
请参见错误码。