Creating a Transit Subnet
Function
This API is used to create a transit subnet.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/private-nat/transit-subnets
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token value. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
transit_subnet |
Yes |
CreateTransitSubnetOption object |
Specifies the request body for creating a transit subnet. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Specifies the transit subnet name. The name can contain only digits, letters, underscores (_), and hyphens (-). |
description |
No |
String |
Provides supplementary information about the transit subnet. The description can contain up to 255 characters and cannot contain angle brackets (<>). |
virsubnet_id |
Yes |
String |
Specifies the transit subnet ID. |
virsubnet_project_id |
Yes |
String |
Specifies the ID of the project to which the transit subnet belongs. Only digits and lowercase letters are supported. |
tags |
No |
Array of Tag objects |
Specifies the tags. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
transit_subnet |
TransitSubnet object |
Specifies the response body of the transit subnet. |
request_id |
String |
Specifies the request ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the transit subnet ID. |
name |
String |
Specifies the transit subnet name. |
description |
String |
Provides supplementary information about the transit subnet. |
virsubnet_project_id |
String |
Specifies the ID of the project to which the transit subnet belongs. |
project_id |
String |
Specifies the project ID. |
vpc_id |
String |
Specifies the ID of the VPC to which the transit subnet belongs. |
virsubnet_id |
String |
Specifies the transit subnet ID. |
cidr |
String |
Specifies the CIDR block of the transit subnet. |
type |
String |
Specifies the transit subnet type. The value can only be VPC. |
status |
String |
Specifies the transit subnet status. The value can be ACTIVE, indicating the transit subnet is normal. |
ip_count |
Integer |
Specifies the number of IP addresses that has been assigned from the transit subnet. |
created_at |
DateTime |
Specifies when the transit subnet was assigned. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format. |
updated_at |
DateTime |
Specifies when the transit subnet was updated. It is a UTC time in yyyy-mm-ddThh:mm:ssZ format. |
tags |
Array of Tag objects |
Specifies the tag list. |
Example Requests
Creating a transit subnet
POST https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/transit-subnets { "transit_subnet" : { "name" : "transit-subnet_t1", "description" : "transit-subnet-description", "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "virsubnet_project_id" : "aea5011c0bc2454d8645a560345da810", "tags" : [ { "key" : "key1", "value" : "value1" } ] } }
Example Responses
Status code: 201
The transit subnet created.
{ "request_id" : "9882046a9b96f1405472e36d797e33dc", "transit_subnet" : { "id" : "48b55781-306c-4a90-9cc0-d376337fae4f", "name" : "transit-subnet_t1", "description" : "transit-subnet-description", "virsubnet_project_id" : "aea5011c0bc2454d8645a560345da810", "project_id" : "aea5011c0bc2454d8645a560345da810", "vpc_id" : "f9169a4f-5f0a-41ce-b2a3-834c15b038c2", "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "cidr" : "192.168.1.0/24", "type" : "VPC", "status" : "ACTIVE", "ip_count" : 0, "created_at" : "2021-07-01T09:15:54Z", "updated_at" : "2021-04-01T09:15:54Z", "tags" : [ { "key" : "key1", "value" : "value1" } ] } }
Status Codes
Status Code |
Description |
---|---|
201 |
The transit subnet created. |
400 |
Bad Request |
409 |
Conflict |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot