创建专线关联连接 - CreatePeerLink
功能介绍
创建专线全域接入网关的关联连接peer-link对象,用于连接企业路由器或者其他接入网关
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取 约束限制: 不涉及 取值范围: 32 位十六进制字符(0-9, a-f, A-F) 默认取值: 不涉及 |
| global_dc_gateway_id | 是 | String | 参数解释: 全域接入网关ID 约束限制: 不涉及 取值范围: UUID 格式,以连字符(-)连接 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 获取Token,请参考《统一身份认证服务API参考》的「获取用户Token」章节。请求响应成功后在响应消息头中包含的「X-Subject-Token」的值即为Token值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| peer_link | 是 | peer_link object | 参数解释: 创建关联连接请求Body体 约束限制: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 关联连接的名称 约束限制: 不涉及 取值范围: 只能包含中文字符、小写字母(a~z)、大写字母(A~Z)、数字(0~9)、中划线(-)、下划线(_)、点(.),0个或多个字符,长度不超过64个字符 默认取值: 不涉及 |
| description | 否 | String | 参数解释: 描述信息 约束限制: 不涉及 取值范围: 长度不超过128个字符 默认取值: 不涉及 |
| peer_site | 是 | peer_site object | 参数解释: 连接站点对象 约束限制: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 请求ID 取值范围: 不涉及 |
| peer_link | ExternalCreatePeerLink object | 参数解释: 创建关联连接返回对象 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 专线对等连接 取值范围: 不涉及 |
| instance_id | String | 参数解释: 专线对等连接实例ID 取值范围: 不涉及 |
| tenant_id | String | 参数解释: 租户ID 取值范围: 不涉及 |
| name | String | 参数解释: 名称 取值范围: 不涉及 |
| description | String | 参数解释: 描述信息 取值范围: 不涉及 |
| global_dc_gateway_id | String | 参数解释: 全域接入网关ID 取值范围: 不涉及 |
| bandwidth_info | BandwidthInfoExternal object | 参数解释: 带宽信息 |
| peer_site | PeerSiteExternal object | 参数解释: 连接站点信息 |
| status | String | 参数解释: 状态信息。 取值范围: |
| reason | String | 参数解释: 失败原因 取值范围: 不涉及 |
| created_time | String | 参数解释: 创建时间 |
| updated_time | String | 参数解释: 更新时间 |
请求示例
专线连接创建请求体
POST https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/1c6edc27-5fdb-4dae-ac77-72d47c70ed83/peer-links
{
"peer_link" : {
"name" : "dgw-peer-link-94dc",
"peer_site" : {
"gateway_id" : "70e29908-12f8-4d5d-9adf-4da5465b91b2",
"project_id" : "b197c48159d44a66b32c538c3f8da89a",
"region_id" : "xxxxxx"
}
}
} 响应示例
状态码:201
专线连接创建返回体
{
"peer_link" : {
"name" : "dgw-peer-link-94dc",
"id" : "d6ea4641-9575-4675-ac4f-906884e37f28",
"tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
"description" : null,
"status" : "PENDING_CREATE",
"reason" : null,
"created_time" : "2024-12-12T00:16:40.000Z",
"global_dc_gateway_id" : "335cb548-0ea0-4aff-80f5-502a2dab5325",
"bandwidth_info" : {
"bandwidth_size" : 0,
"gcb_id" : null
},
"peer_site" : {
"gateway_id" : "70e29908-12f8-4d5d-9adf-4da5465b91b2",
"link_id" : null,
"region_id" : "xxxxxx",
"site_code" : "xxxxxx",
"project_id" : "b197c48159d44a66b32c538c3f8da89a",
"type" : "ER"
},
"instance_id" : null,
"updated_time" : "2024-12-12T00:16:40.000Z"
},
"request_id" : "196ab00b7bbf03be9187606853d80cee"
} SDK代码示例
SDK代码示例如下。
Java
专线连接创建请求体
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 | 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 CreatePeerLinkSolution { 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(); CreatePeerLinkRequest request = new CreatePeerLinkRequest(); request.withGlobalDcGatewayId("{global_dc_gateway_id}"); CreateExternalPeerLinkRequestBody body = new CreateExternalPeerLinkRequestBody(); CreateExternalPeerLinkRequestBodyPeerLinkPeerSite peerSitePeerLink = new CreateExternalPeerLinkRequestBodyPeerLinkPeerSite(); peerSitePeerLink.withGatewayId("70e29908-12f8-4d5d-9adf-4da5465b91b2") .withProjectId("b197c48159d44a66b32c538c3f8da89a") .withRegionId("xxxxxx"); CreateExternalPeerLinkRequestBodyPeerLink peerLinkbody = new CreateExternalPeerLinkRequestBodyPeerLink(); peerLinkbody.withName("dgw-peer-link-94dc") .withPeerSite(peerSitePeerLink); body.withPeerLink(peerLinkbody); request.withBody(body); try { CreatePeerLinkResponse response = client.createPeerLink(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()); } } } |
Python
专线连接创建请求体
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 | # 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 = CreatePeerLinkRequest() request.global_dc_gateway_id = "{global_dc_gateway_id}" peerSitePeerLink = CreateExternalPeerLinkRequestBodyPeerLinkPeerSite( gateway_id="70e29908-12f8-4d5d-9adf-4da5465b91b2", project_id="b197c48159d44a66b32c538c3f8da89a", region_id="xxxxxx" ) peerLinkbody = CreateExternalPeerLinkRequestBodyPeerLink( name="dgw-peer-link-94dc", peer_site=peerSitePeerLink ) request.body = CreateExternalPeerLinkRequestBody( peer_link=peerLinkbody ) response = client.create_peer_link(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
专线连接创建请求体
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 60 61 62 | 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.CreatePeerLinkRequest{} request.GlobalDcGatewayId = "{global_dc_gateway_id}" peerSitePeerLink := &model.CreateExternalPeerLinkRequestBodyPeerLinkPeerSite{ GatewayId: "70e29908-12f8-4d5d-9adf-4da5465b91b2", ProjectId: "b197c48159d44a66b32c538c3f8da89a", RegionId: "xxxxxx", } peerLinkbody := &model.CreateExternalPeerLinkRequestBodyPeerLink{ Name: "dgw-peer-link-94dc", PeerSite: peerSitePeerLink, } request.Body = &model.CreateExternalPeerLinkRequestBody{ PeerLink: peerLinkbody, } response, err := client.CreatePeerLink(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 201 | Created |
错误码
请参见错误码。