创建终端节点
功能介绍
创建终端节点。
调用方法
请参见如何调用API。
URI
POST /v2.1/endpoints
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
待创建的终端节点名称。 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 |
direction |
是 |
String |
终端节点方向。 取值: inbound,表示入站终端节点。 outbound,表示出站终端节点。 |
region |
是 |
String |
当前子网所在的region。 |
ipaddresses |
是 |
Array of IpaddressInfo objects |
终端节点的IP地址和子网信息。最少需要添加2个IP地址,最多可以添加6个IP地址。 |
响应参数
状态码:202
参数 |
参数类型 |
描述 |
---|---|---|
endpoint |
EndpointResp object |
终端节点对象。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
终端节点的ID,UUID形式的一个资源标识。 |
name |
String |
终端节点的名称。 |
direction |
String |
终端节点方向。 取值: inbound,表示入站终端节点。 outbound,表示出站终端节点。 |
status |
String |
资源状态。 取值范围:PENDING_CREATE, ACTIVE, PENDING_DELETE, ERROR。 |
vpc_id |
String |
终端节点所属的VPC ID。 |
ipaddress_count |
Integer |
该终端节点下的IP地址数量。 |
resolver_rule_count |
Integer |
该终端节点下的转发规则数量。 仅创建出站终端节点时返回该参数。 |
create_time |
String |
创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 |
update_time |
String |
更新时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码。 |
message |
String |
错误描述。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码。 |
message |
String |
错误描述。 |
请求示例
创建入站终端节点,设置IP地址1的子网ID为 "0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为 "192.168.3.125";设置IP地址2的子网ID为"0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为"192.168.3.126"。
POST https://{endpoint}/v2.1/endpoints { "name" : "poi-1", "direction" : "inbound", "region" : "NetworkService", "ipaddresses" : [ { "subnet_id" : "0463c8a5-fa49-441d-b28b-bc6c35ba04f8", "ip" : "192.168.3.125" }, { "subnet_id" : "0463c8a5-fa49-441d-b28b-bc6c35ba04f8", "ip" : "192.168.3.126" } ] }
响应示例
状态码:202
创建终端节点响应。
{ "endpoint" : { "id" : "ff80808169bf16c70169bf1d02270000", "name" : "poi-1", "direction" : "inbound", "status" : "PENDING_CREATE", "vpc_id" : null, "ipaddress_count" : 0, "resolver_rule_count" : 0, "create_time" : "2019-03-27T12:25:43.181", "update_time" : "2019-03-27T12:25:43.181" } }
SDK代码示例
SDK代码示例如下。
创建入站终端节点,设置IP地址1的子网ID为 "0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为 "192.168.3.125";设置IP地址2的子网ID为"0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为"192.168.3.126"。
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 63 64 |
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.dns.v2.region.DnsRegion; import com.huaweicloud.sdk.dns.v2.*; import com.huaweicloud.sdk.dns.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreateEndpointSolution { 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); DnsClient client = DnsClient.newBuilder() .withCredential(auth) .withRegion(DnsRegion.valueOf("<YOUR REGION>")) .build(); CreateEndpointRequest request = new CreateEndpointRequest(); CreateEndpointRequestBody body = new CreateEndpointRequestBody(); List<IpaddressInfo> listbodyIpaddresses = new ArrayList<>(); listbodyIpaddresses.add( new IpaddressInfo() .withSubnetId("0463c8a5-fa49-441d-b28b-bc6c35ba04f8") .withIp("192.168.3.125") ); listbodyIpaddresses.add( new IpaddressInfo() .withSubnetId("0463c8a5-fa49-441d-b28b-bc6c35ba04f8") .withIp("192.168.3.126") ); body.withIpaddresses(listbodyIpaddresses); body.withRegion("NetworkService"); body.withDirection("inbound"); body.withName("poi-1"); request.withBody(body); try { CreateEndpointResponse response = client.createEndpoint(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()); } } } |
创建入站终端节点,设置IP地址1的子网ID为 "0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为 "192.168.3.125";设置IP地址2的子网ID为"0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为"192.168.3.126"。
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdns.v2.region.dns_region import DnsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdns.v2 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"] credentials = BasicCredentials(ak, sk) client = DnsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DnsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateEndpointRequest() listIpaddressesbody = [ IpaddressInfo( subnet_id="0463c8a5-fa49-441d-b28b-bc6c35ba04f8", ip="192.168.3.125" ), IpaddressInfo( subnet_id="0463c8a5-fa49-441d-b28b-bc6c35ba04f8", ip="192.168.3.126" ) ] request.body = CreateEndpointRequestBody( ipaddresses=listIpaddressesbody, region="NetworkService", direction="inbound", name="poi-1" ) response = client.create_endpoint(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
创建入站终端节点,设置IP地址1的子网ID为 "0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为 "192.168.3.125";设置IP地址2的子网ID为"0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为"192.168.3.126"。
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/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 := dns.NewDnsClient( dns.DnsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateEndpointRequest{} ipIpaddresses:= "192.168.3.125" ipIpaddresses1:= "192.168.3.126" var listIpaddressesbody = []model.IpaddressInfo{ { SubnetId: "0463c8a5-fa49-441d-b28b-bc6c35ba04f8", Ip: &ipIpaddresses, }, { SubnetId: "0463c8a5-fa49-441d-b28b-bc6c35ba04f8", Ip: &ipIpaddresses1, }, } request.Body = &model.CreateEndpointRequestBody{ Ipaddresses: listIpaddressesbody, Region: "NetworkService", Direction: "inbound", Name: "poi-1", } response, err := client.CreateEndpoint(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
202 |
创建终端节点响应。 |
400 |
接口错误响应。 |
500 |
接口错误响应。 |
错误码
请参见错误码。