Updating a Hosted Connection
Function
This API is used by partners to update a hosted connection.
Calling Method
For details, see Calling APIs.
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, the following identity policy-based permissions are required.
URI
PUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Specifies the project ID. Constraints N/A Range N/A Default Value N/A |
| hosted_connect_id | Yes | String | Definition Specifies the hosted connection ID. Constraints N/A Range The value can contain up to 36 characters in UUID format and is connected by hyphens (-). Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| hosted_connect | No | UpdateHostedDirectConnect object | Definition Specifies the hosted connection to be updated. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | No | String | Definition Specifies the connection name. Constraints N/A Range The value can contain a maximum of 64 characters. Default Value N/A |
| description | No | String | Definition Provides supplementary information about the connection. Constraints N/A Range The value can contain a maximum of 128 characters. Default Value N/A |
| bandwidth | No | Integer | Definition Specifies the bandwidth of the hosted connection, in Mbit/s. Constraints N/A Range N/A Default Value N/A |
| peer_location | No | String | Definition Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name. Constraints N/A Range The value can contain a maximum of 255 characters. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| request_id | String | Definition Specifies the request ID. Range N/A |
| hosted_connect | HostedDirectConnect object | Definition Specifies the hosted connection object information. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Specifies the hosted connection ID. Range The value can contain a maximum of 36 characters. |
| tenant_id | String | Definition Specifies the project ID. Range N/A |
| name | String | Definition Specifies the name of the hosted connection. Range The value can contain a maximum of 64 characters. |
| description | String | Definition Provides supplementary information about the hosted connection. Range The value can contain a maximum of 128 characters. |
| bandwidth | Integer | Definition Specifies the bandwidth of the hosted connection, in Mbit/s. Range N/A |
| location | String | Definition Specifies information about the Direct Connect location. Range The value can contain a maximum of 255 characters. |
| peer_location | String | Definition Specifies the location of the on-premises facility at the other end of the hosted connection, specific to the street or data center name. Range The value can contain a maximum of 255 characters. |
| hosting_id | String | Definition Specifies the ID of the operations connection on which the hosted connection is created. Range The value is in UUID format and is connected by hyphens (-). |
| provider | String | Definition Specifies the provider of the leased line. Range N/A |
| admin_state_up | Boolean | Definition Managing a status Range |
| vlan | Integer | Definition Specifies the VLAN pre-allocated to the hosted connection. Range 0–3999 |
| status | String | Definition Specifies the operation status. Range |
| apply_time | String | Definition Specifies when the hosted connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ. |
| create_time | String | Definition Specifies when the hosted connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ. |
| provider_status | String | Definition Specifies the carrier operation status of the hosted connection. Range |
| port_type | String | Definition Specifies the type of the port used by the hosted connection. The value can be 1G, 10G, 40G, or 100G. Range |
| type | String | Definition Specifies the type of the hosted connection. The value can be standard (a standard connection), hosting (an operations connection), or hosted (a hosted connection). Range |
Example Requests
Updating the name and description of a hosted connection
PUT https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects/0278b472-ffa5-4eb3-8c0d-979d479f8ef6
{
"hosted_connect" : {
"name" : "client-dc-faf1",
"description" : ""
}
} Example Responses
Status code: 200
-
The hosted connection is updated.
{ "hosted_connect" : { "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6", "name" : "client-dc-faf1", "description" : "", "tenant_id" : "0605768a3300d5762f82c01180692873", "hosting_id" : "2cfb53be-b05f-40d5-a2f8-3a59ac383836", "vlan" : 441, "bandwidth" : 10, "location" : "ExampleLocation", "peer_location" : "", "provider" : "others", "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.
Updating the name and description of a hosted connection
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 | 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 UpdateHostedDirectConnectSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); UpdateHostedDirectConnectRequest request = new UpdateHostedDirectConnectRequest(); request.withHostedConnectId("{hosted_connect_id}"); UpdateHostedDirectConnectRequestBody body = new UpdateHostedDirectConnectRequestBody(); UpdateHostedDirectConnect hostedConnectbody = new UpdateHostedDirectConnect(); hostedConnectbody.withName("client-dc-faf1") .withDescription(""); body.withHostedConnect(hostedConnectbody); request.withBody(body); try { UpdateHostedDirectConnectResponse response = client.updateHostedDirectConnect(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()); } } } |
Updating the name and description of a hosted connection
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 | # coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateHostedDirectConnectRequest() request.hosted_connect_id = "{hosted_connect_id}" hostedConnectbody = UpdateHostedDirectConnect( name="client-dc-faf1", description="" ) request.body = UpdateHostedDirectConnectRequestBody( hosted_connect=hostedConnectbody ) response = client.update_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) |
Updating the name and description of a hosted connection
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 56 57 58 59 | 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dc.NewDcClient(hcClient) request := &model.UpdateHostedDirectConnectRequest{} request.HostedConnectId = "{hosted_connect_id}" nameHostedConnect:= "client-dc-faf1" descriptionHostedConnect:= "" hostedConnectbody := &model.UpdateHostedDirectConnect{ Name: &nameHostedConnect, Description: &descriptionHostedConnect, } request.Body = &model.UpdateHostedDirectConnectRequestBody{ HostedConnect: hostedConnectbody, } response, err := client.UpdateHostedDirectConnect(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 |
|---|---|
| 200 | OK |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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