Querying Details About a Hosted Connection
Function
This API is used by partners to query a hosted connection.
Debugging
For details, see Calling APIs.
URI
GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
hosted_connect_id |
Yes |
String |
Specifies the hosted connection ID. Minimum: 36 Maximum: 36 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of records returned on each page. Value range: 1–2000 Minimum: 1 Maximum: 2000 Default: 2000 |
marker |
No |
String |
Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 0 Maximum: 36 |
fields |
No |
Array |
Specifies the list of fields to be displayed. Array length: 1–5 |
sort_dir |
No |
Array |
Specifies the sorting order of returned results. The value can be asc (default) or desc. |
sort_key |
No |
String |
Specifies the field for sorting. Default: id Minimum: 0 Maximum: 36 |
hosting_id |
No |
Array |
Specifies operations connection ID by which hosted connections are queried. Array length: 0–5 |
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. |
hosted_connect |
HostedDirectConnect object |
Specifies the hosted connection. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the hosted connection ID. Minimum: 36 Maximum: 36 |
tenant_id |
String |
Specifies the project ID. |
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. The value 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.
Enumeration values:
|
apply_time |
String |
Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ. |
create_time |
String |
Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ. |
provider_status |
String |
Specifies the carrier status. 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 the connection. The value is hosted. Default: hosted |
Example Requests
Querying details about a hosted connection created by a partner
GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects/0278b472-ffa5-4eb3-8c0d-979d479f8ef6
Example Responses
Status code: 200
OK
- The details of the hosted connection are queried.
{ "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" : "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.
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 |
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.*; import java.util.List; import java.util.ArrayList; public class ShowHostedDirectConnectSolution { 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(); ShowHostedDirectConnectRequest request = new ShowHostedDirectConnectRequest(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withFields(); request.withSortDir(); request.withSortKey("<sort_key>"); request.withHostingId(); try { ShowHostedDirectConnectResponse response = client.showHostedDirectConnect(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()); } } } |
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 |
# 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 = ShowHostedDirectConnectRequest() request.limit = <limit> request.marker = "<marker>" request.fields = request.sort_dir = request.sort_key = "<sort_key>" request.hosting_id = response = client.show_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) |
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 |
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.ShowHostedDirectConnectRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest response, err := client.ShowHostedDirectConnect(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.
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 |
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.*; import java.util.List; import java.util.ArrayList; public class ShowHostedDirectConnectSolution { 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(); ShowHostedDirectConnectRequest request = new ShowHostedDirectConnectRequest(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withFields(); request.withSortDir(); request.withSortKey("<sort_key>"); request.withHostingId(); try { ShowHostedDirectConnectResponse response = client.showHostedDirectConnect(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()); } } } |
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 |
# 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 = ShowHostedDirectConnectRequest() request.limit = <limit> request.marker = "<marker>" request.fields = request.sort_dir = request.sort_key = "<sort_key>" request.hosting_id = response = client.show_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) |
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 |
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.ShowHostedDirectConnectRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest response, err := client.ShowHostedDirectConnect(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.
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