Creating a Hosted Connection
Function
This API is used by partners to create hosted connections for their users. The creator must have the partner qualification and have an operations connection.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/dcaas/hosted-connects
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
hosted_connect |
Yes |
CreateHostedDirectConnect object |
Specifies the parameters for creating a hosted connection. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Specifies the hosted connection name. Minimum: 0 Maximum: 64 |
description |
No |
String |
Provides supplementary information about the hosted connection. Minimum: 0 Maximum: 128 |
bandwidth |
Yes |
Integer |
Specifies the bandwidth size of the hosted connection in Mbit/s. Minimum: 2 Maximum: 400000 |
hosting_id |
Yes |
String |
Specifies the ID of the operations connection on which the hosted connection is created. |
vlan |
Yes |
Integer |
Specifies the VLAN allocated to the hosted connection. Minimum: 0 Maximum: 3999 |
resource_tenant_id |
Yes |
String |
Specifies the project ID of the specified tenant for whom a hosted connection is to be created. Minimum: 0 Maximum: 32 |
peer_location |
No |
String |
Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name. Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. |
hosted_connect |
HostedDirectConnect object |
Specifies the parameters for creating a hosted connection. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the hosted connection ID. Minimum: 36 Maximum: 36 |
tenant_id |
String |
Specifies the ID of the project that the instance belongs to. |
name |
String |
Specifies the connection name. Minimum: 0 Maximum: 64 |
description |
String |
Provides supplementary information about the connection. Minimum: 0 Maximum: 128 |
bandwidth |
Integer |
Specifies the connection bandwidth in Mbit/s. Minimum: 2 Maximum: 400000 |
location |
String |
Specifies information about the Direct Connect location. Minimum: 0 Maximum: 255 |
peer_location |
String |
Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name. Minimum: 0 Maximum: 255 |
hosting_id |
String |
Specifies the ID of the operations connection on which the hosted connection is created. |
provider |
String |
Specifies the provider of the leased line. |
admin_state_up |
Boolean |
Specifies the administrative status, which can be true or false. Default: true |
vlan |
Integer |
Specifies the VLAN allocated to the hosted connection. Minimum: 0 Maximum: 3999 |
status |
String |
Specifies the operating status of the hosted connection. The options are as follows:
Enumeration values:
|
apply_time |
String |
Specifies when the connection was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used. |
create_time |
String |
Specifies when the connection was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used. |
provider_status |
String |
Specifies the status of the carrier's leased line. The status can be ACTIVE or DOWN. Enumeration values:
|
port_type |
String |
Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G. Enumeration values:
|
type |
String |
Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection). Default: standard Enumeration values:
|
Example Requests
Creating a hosting connection with the bandwidth set to 10 Mbit/s and VLAN to 441
POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects { "hosted_connect" : { "name" : "client-dc-faf1", "description" : "Hosted Connect", "resource_tenant_id" : "0605768a3300d5762f82c01180692873", "hosting_id" : "2cfb53be-b05f-40d5-a2f8-3a59ac383836", "vlan" : 441, "bandwidth" : 10 } }
Example Responses
Status code: 201
Created
- The hosted connection is created.
{ "hosted_connect" : { "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6", "name" : "client-dc-faf1", "description" : "Hosted Connect", "tenant_id" : "0605768a3300d5762f82c01180692873", "hosting_id" : "2cfb53be-b05f-40d5-a2f8-3a59ac383836", "vlan" : 441, "bandwidth" : 10, "location" : "ExampleLocation", "peer_location" : "", "provider" : "ExampleProvider", "type" : "hosted", "port_type" : "10G", "provider_status" : "ACTIVE", "status" : "ACTIVE", "apply_time" : "2022-07-13T08:25:38.000Z", "admin_state_up" : true, "create_time" : "2022-07-13T08:25:38.000Z" }, "request_id" : "a59a3776faa1d055f8124dc7b0977a90" }
SDK Sample Code
The SDK sample code is as follows.
Creating a hosting connection with the bandwidth set to 10 Mbit/s and VLAN to 441
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dc.v3.region.DcRegion; import com.huaweicloud.sdk.dc.v3.*; import com.huaweicloud.sdk.dc.v3.model.*; public class CreateHostedDirectConnectSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); CreateHostedDirectConnectRequest request = new CreateHostedDirectConnectRequest(); CreateHostedDirectConnectRequestBody body = new CreateHostedDirectConnectRequestBody(); CreateHostedDirectConnect hostedConnectbody = new CreateHostedDirectConnect(); hostedConnectbody.withName("client-dc-faf1") .withDescription("Hosted Connect") .withBandwidth(10) .withHostingId("2cfb53be-b05f-40d5-a2f8-3a59ac383836") .withVlan(441) .withResourceTenantId("0605768a3300d5762f82c01180692873"); body.withHostedConnect(hostedConnectbody); request.withBody(body); try { CreateHostedDirectConnectResponse response = client.createHostedDirectConnect(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Creating a hosting connection with the bandwidth set to 10 Mbit/s and VLAN to 441
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdc.v3.region.dc_region import DcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateHostedDirectConnectRequest() hostedConnectbody = CreateHostedDirectConnect( name="client-dc-faf1", description="Hosted Connect", bandwidth=10, hosting_id="2cfb53be-b05f-40d5-a2f8-3a59ac383836", vlan=441, resource_tenant_id="0605768a3300d5762f82c01180692873" ) request.body = CreateHostedDirectConnectRequestBody( hosted_connect=hostedConnectbody ) response = client.create_hosted_direct_connect(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating a hosting connection with the bandwidth set to 10 Mbit/s and VLAN to 441
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dc.NewDcClient( dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateHostedDirectConnectRequest{} nameHostedConnect:= "client-dc-faf1" descriptionHostedConnect:= "Hosted Connect" hostedConnectbody := &model.CreateHostedDirectConnect{ Name: &nameHostedConnect, Description: &descriptionHostedConnect, Bandwidth: int32(10), HostingId: "2cfb53be-b05f-40d5-a2f8-3a59ac383836", Vlan: int32(441), ResourceTenantId: "0605768a3300d5762f82c01180692873", } request.Body = &model.CreateHostedDirectConnectRequestBody{ HostedConnect: hostedConnectbody, } response, err := client.CreateHostedDirectConnect(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
Created |
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