Creating a RoCE Network

Function

This API is used to create a RoCE network in the system. It is used when you need to create a dedicated RoCE network for high-performance computing or low-latency applications. Before using this API, ensure that you have logged in to the system and have the permission to create a RoCE network, and the required network resources have been configured in the system. After the creation, a RoCE network is created, and details about the RoCE network are returned, including the network ID, subnet information, and configuration parameters. If you do not have the required permission, the system lacks necessary network resources, or the network configuration parameters are invalid, the API returns an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/dev-servers/networks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
network_type	No	String	Definition: RoCE network type. Constraints: N/A Range: vxlan_roce roce_v2 Default Value: N/A
physical_network	No	String	Definition: Physical network name. Constraints: ^[-_.a-zA-Z0-9]{1,64}$ Range: N/A Default Value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
network	ServerRoceNetwork object	Definition: Network details.

**Table 4** ServerRoceNetwork
Parameter	Type	Description
id	String	Definition: RoCE network ID. Range: N/A
name	String	Definition: RoCE network name. Range: N/A
project_id	String	Definition: Project ID. Range: N/A
status	String	Definition: Status. Definition: N/A
tenant_id	String	Definition: Tenant ID. Range: N/A
subnets	String	Definition: Subnet. Range: N/A
provider:network_type	String	Definition: RoCE network type. Range: N/A
provider:physical_network	String	Definition: Physical network. Range: N/A

Example Requests

POST https://{endpoint}/v1/{project_id}/dev-servers/networks

{
  "network_type" : "vxlan_roce",
  "physical_network" : "roce_pod101"
}

Example Responses

Status code: 200

Definition: Network details

{
  "network" : {
    "id" : "11111cfe-7234-4105-8307-0f7eb8a0244c",
    "name" : "lite server_roce_pod101_0b15",
    "project_id" : "11111583c880d2362fd1c012d7bb14bf",
    "provider:network_type" : "vxlan_roce",
    "provider:physical_network" : "roce_pod101",
    "status" : "ACTIVE",
    "tenant_id" : "11111583c880d2362fd1c012d7bb14bf",
    "subnets" : "[\"11111d19-8a52-417e-9fef-aa88e68ac4a5\"]"
  }
}