内网DNS
初始化
确认Endpoint
内网DNS API 的服务域名为:privatezone.baidubce.com
API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性,建议通过HTTPS调用。
获取密钥
要使用百度云LD,您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的,均为字符串,用于标识用户,为访问LD做签名验证。
可以通过如下步骤获得并了解您的AK/SK信息:
新建LD Client
LD Client是LD服务的客户端,为开发者与LD服务进行交互提供了一系列的方法。
使用AK/SK新建LD Client
通过AK/SK方式访问LD,用户可以参考如下代码新建一个LD Client:
1import (
2 "github.com/baidubce/bce-sdk-go/services/localDns"
3)
4
5func main() {
6 // 用户的Access Key ID和Secret Access Key
7 ACCESS_KEY_ID, SECRET_ACCESS_KEY := <your-access-key-id>, <your-secret-access-key>
8
9 // 用户指定的Endpoint
10 ENDPOINT := <domain-name>
11
12 // 初始化一个LDClient
13 ldClient, err := ld.NewClient(AK, SK, ENDPOINT)
14}
在上面代码中,ACCESS_KEY_ID
对应控制台中的“Access Key ID”,SECRET_ACCESS_KEY
对应控制台中的“Access Key Secret”,获取方式请参考《操作指南 如何获取AKSK》。第三个参数ENDPOINT
支持用户自己指定域名,如果设置为空字符串,会使用默认域名作为LD的服务地址。
使用STS创建LD Client
申请STS token
LD可以通过STS机制实现第三方的临时授权访问。STS(Security Token Service)是百度云提供的临时授权服务。通过STS,您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度云的API或SDK访问百度云资源。
通过STS方式访问LD,用户需要先通过STS的client申请一个认证字符串。
用STS token新建LD Client
申请好STS后,可将STS Token配置到LD Client中,从而实现通过STS Token创建LD Client。
代码示例
GO SDK实现了STS服务的接口,用户可以参考如下完整代码,实现申请STS Token和创建LD Client对象:
1import (
2 "fmt"
3
4 "github.com/baidubce/bce-sdk-go/auth" //导入认证模块
5 "github.com/baidubce/bce-sdk-go/services/localDns" //导入LD服务模块
6 "github.com/baidubce/bce-sdk-go/services/sts" //导入STS服务模块
7)
8
9func main() {
10 // 创建STS服务的Client对象,Endpoint使用默认值
11 AK, SK := <your-access-key-id>, <your-secret-access-key>
12 stsClient, err := sts.NewClient(AK, SK)
13 if err != nil {
14 fmt.Println("create sts client object :", err)
15 return
16 }
17
18 // 获取临时认证token,有效期为60秒,ACL为空
19 stsObj, err := stsClient.GetSessionToken(60, "")
20 if err != nil {
21 fmt.Println("get session token failed:", err)
22 return
23 }
24 fmt.Println("GetSessionToken result:")
25 fmt.Println(" accessKeyId:", stsObj.AccessKeyId)
26 fmt.Println(" secretAccessKey:", stsObj.SecretAccessKey)
27 fmt.Println(" sessionToken:", stsObj.SessionToken)
28 fmt.Println(" createTime:", stsObj.CreateTime)
29 fmt.Println(" expiration:", stsObj.Expiration)
30 fmt.Println(" userId:", stsObj.UserId)
31
32 // 使用申请的临时STS创建LD服务的Client对象,Endpoint使用默认值
33 ldClient, err := ld.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "privatezone.baidubce.com")
34 if err != nil {
35 fmt.Println("create localDns client failed:", err)
36 return
37 }
38 stsCredential, err := auth.NewSessionBceCredentials(
39 stsObj.AccessKeyId,
40 stsObj.SecretAccessKey,
41 stsObj.SessionToken)
42 if err != nil {
43 fmt.Println("create sts credential object failed:", err)
44 return
45 }
46 ldClient.Config.Credentials = stsCredential
47}
注意: 目前使用STS配置LD Client时,STS的Endpoint需配置为http://sts.bj.baidubce.com。
配置HTTPS协议访问LD
LD支持HTTPS传输协议,您可以通过在创建LD Client对象时指定的Endpoint中指明HTTPS的方式,在LD GO SDK中使用HTTPS访问LD服务:
1// import "github.com/baidubce/bce-sdk-go/services/localDns"
2
3ENDPOINT := "https://privatezone.baidubce.com " //指明使用HTTPS协议
4AK, SK := <your-access-key-id>, <your-secret-access-key>
5ldClient, _ := ld.NewClient(AK, SK, ENDPOINT)
配置LD Client
如果用户需要配置LD Client的一些细节的参数,可以在创建LD Client对象之后,使用该对象的导出字段Config
进行自定义配置,可以为客户端配置代理,最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问LD服务:
1// import "github.com/baidubce/bce-sdk-go/services/localDns"
2
3//创建LD Client对象
4AK, SK := <your-access-key-id>, <your-secret-access-key>
5ENDPOINT := "privatezone.baidubce.com"
6client, _ := ld.NewClient(AK, SK, ENDPOINT)
7
8//代理使用本地的8080端口
9client.Config.ProxyUrl = "127.0.0.1:8080"
设置网络参数
用户可以通过如下的示例代码进行网络参数的设置:
1// import "github.com/baidubce/bce-sdk-go/services/localDns"
2
3AK, SK := <your-access-key-id>, <your-secret-access-key>
4ENDPOINT := "privatezone.baidubce.com"
5client, _ := ld.NewClient(AK, SK, ENDPOINT)
6
7// 配置不进行重试,默认为Back Off重试
8client.Config.Retry = bce.NewNoRetryPolicy()
9
10// 配置连接超时时间为30秒
11client.Config.ConnectionTimeoutInMillis = 30 * 1000
配置生成签名字符串选项
1// import "github.com/baidubce/bce-sdk-go/services/localDns"
2
3AK, SK := <your-access-key-id>, <your-secret-access-key>
4ENDPOINT := "privatezone.baidubce.com"
5client, _ := ld.NewClient(AK, SK, ENDPOINT)
6
7// 配置签名使用的HTTP请求头为`Host`
8headersToSign := map[string]struct{}{"Host": struct{}{}}
9client.Config.SignOption.HeadersToSign = HeadersToSign
10
11// 配置签名的有效期为30秒
12client.Config.SignOption.ExpireSeconds = 30
参数说明
用户使用GO SDK访问LD时,创建的LD Client对象的Config
字段支持的所有参数如下表所示:
配置项名称 | 类型 | 含义 |
---|---|---|
Endpoint | string | 请求服务的域名 |
ProxyUrl | string | 客户端请求的代理地址 |
Region | string | 请求资源的区域 |
UserAgent | string | 用户名称,HTTP请求的User-Agent头 |
Credentials | *auth.BceCredentials | 请求的鉴权对象,分为普通AK/SK与STS两种 |
SignOption | *auth.SignOptions | 认证字符串签名选项 |
Retry | RetryPolicy | 连接重试策略 |
ConnectionTimeoutInMillis | int | 连接超时时间,单位毫秒,默认20分钟 |
说明:
Credentials
字段使用auth.NewBceCredentials
与auth.NewSessionBceCredentials
函数创建,默认使用前者,后者为使用STS鉴权时使用,详见“使用STS创建LD Client”小节。SignOption
字段为生成签名字符串时的选项,详见下表说明:
名称 | 类型 | 含义 |
---|---|---|
HeadersToSign | map[string]struct{} | 生成签名字符串时使用的HTTP头 |
Timestamp | int64 | 生成的签名字符串中使用的时间戳,默认使用请求发送时的值 |
ExpireSeconds | int | 签名字符串的有效期 |
其中,HeadersToSign默认为
Host
,Content-Type
,Content-Length
,Content-MD5
;TimeStamp一般为零值,表示使用调用生成认证字符串时的时间戳,用户一般不应该明确指定该字段的值;ExpireSeconds默认为1800秒即30分钟。
Retry
字段指定重试策略,目前支持两种:NoRetryPolicy
和BackOffRetryPolicy
。默认使用后者,该重试策略是指定最大重试次数、最长重试时间和重试基数,按照重试基数乘以2的指数级增长的方式进行重试,直到达到最大重试测试或者最长重试时间为止。
创建PrivateZone
函数声明
1type CreatePrivateZoneRequest struct {
2 ClientToken string `json:"-"`
3 ZoneName string `json:"zoneName"`
4}
5
6type CreatePrivateZoneResponse struct {
7 ZoneId string `json:"zoneId"`
8}
9
10func (c *Client) CreatePrivateZone(body *CreatePrivateZoneRequest) (*CreatePrivateZoneResponse, error)
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/jkk6kkh7x
返回值
操作成功:
1{
2 "zoneId":"zone-jkgdns3h"
3}
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_create_private_zone.go
删除PrivateZone
函数声明
1func (c *Client) DeletePrivateZone(zoneId string, clientToken string) error
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Kkk6kpur9
返回值
操作成功:
1// 无返回body
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_delete_private_zone.go
查询PrivateZone列表
函数声明
1type ListPrivateZoneRequest struct {
2 Marker string
3 MaxKeys int
4}
5
6type ListPrivateZoneResponse struct {
7 Marker string `json:"marker"`
8 IsTruncated bool `json:"isTruncated"`
9 NextMarker string `json:"nextMarker"`
10 MaxKeys int32 `json:"maxKeys"`
11 Zones []Zone `json:"zones"`
12}
13
14func (c *Client) ListPrivateZone(request *ListPrivateZoneRequest) (*ListPrivateZoneResponse, error)
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Bkk6l42dl
返回值
操作成功:
1{
2 "nextMarker": "zone-xktdeMSf",
3 "marker": "zone-IyWRnII7",
4 "maxKeys": 1,
5 "isTruncated": true,
6 "zones": [{
7 "zoneId": "zone-IyWRnII7",
8 "zoneName": "baidu.com",
9 "recordCount": 2,
10 "createTime": "2018-12-26 20:30:45",
11 "updateTime": "2018-12-28 21:35:40"
12 }]
13}
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_list_private_zone.go
查询PrivateZone详情
函数声明
1type GetPrivateZoneResponse struct {
2 ZoneId string `json:"zoneId"`
3 ZoneName string `json:"zoneName"`
4 RecordCount int32 `json:"recordCount"`
5 CreateTime string `json:"createTime"`
6 UpdateTime string `json:"updateTime"`
7 BindVpcs []Vpc `json:"bindVpcs"`
8}
9
10func (c *Client) GetPrivateZone(zoneId string) (*GetPrivateZoneResponse, error)
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Jkk6lc8li
返回值
操作成功:
1{
2 "zoneId": "zone-xktdeMSf",
3 "zoneName": "baidu1.com",
4 "recordCount": 2,
5 "createTime": "2018-12-26 20:30:45",
6 "updateTime": "2018-12-28 21:35:40"
7 "bindVpcs": [{
8 "vpcId": "vpc-jikh8hds",
9 "vpcName": "vpcTest",
10 "vpcRegion": "bj"
11 }]
12}
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_get_private_zone.go
关联VPC
函数声明
1type BindVpcRequest struct {
2 ClientToken string `json:"-"`
3 Region string `json:"region"`
4 VpcIds []string `json:"vpcIds"`
5}
6
7
8func (c *Client) BindVpc(zoneId string, body *BindVpcRequest) error
参数含义
请参考OpenApi文档: https://cloud.baidu.com/doc/DNS/s/qkk6lg1af
返回值
操作成功:
1// 无返回body
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_bind_vpc.go
解关联VPC
函数声明
1type UnbindVpcRequest struct {
2 ClientToken string `json:"-"`
3 Region string `json:"region"`
4 VpcIds []string `json:"vpcIds"`
5}
6
7func (c *Client) UnbindVpc(zoneId string, body *UnbindVpcRequest) error
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Dkk6lkyy1
返回值
操作成功:
1// 无返回body
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_unbind_vpc.go
添加解析记录
函数声明
1type AddRecordRequest struct {
2 ClientToken string `json:"-"`
3 Rr string `json:"rr"`
4 Value string `json:"value"`
5 Type string `json:"type"`
6 Ttl int32 `json:"ttl,omitempty"`
7 Priority int32 `json:"priority,omitempty"`
8 Description string `json:"description,omitempty"`
9}
10
11type AddRecordResponse struct {
12 RecordId string `json:"recordId"`
13}
14
15func (c *Client) AddRecord(zoneId string, body *AddRecordRequest) (*AddRecordResponse, error)
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Pkk6lpe4e
返回值
操作成功:
1{
2 "recordId":"rc-jih8hd5s"
3}
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_add_record.go
修改解析记录
函数声明
1type UpdateRecordRequest struct {
2 ClientToken string `json:"-"`
3 Rr string `json:"rr"`
4 Value string `json:"value"`
5 Type string `json:"type"`
6 Ttl int32 `json:"ttl,omitempty"`
7 Priority int32 `json:"priority,omitempty"`
8 Description string `json:"description,omitempty"`
9}
10
11func (c *Client) UpdateRecord(recordId string, body *UpdateRecordRequest) error
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Dkk6lu5ds
返回值
操作成功:
1// 无返回body
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_update_record.go
删除解析记录
函数声明
1func (c *Client) DeleteRecord(recordId string, clientToken string) error
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Lkk6lx4f1
返回值
操作成功:
1// 无返回body
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_delete_record.go
查询解析记录列表
函数声明
1type ListRecordResponse struct {
2 Marker string `json:"marker"`
3 IsTruncated bool `json:"isTruncated"`
4 NextMarker string `json:"nextMarker"`
5 MaxKeys int32 `json:"maxKeys"`
6 Records []Record `json:"records"`
7}
8
9func (c *Client) ListRecord(zoneId string) (*ListRecordResponse, error)
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Ckk6m3d7a
返回值
操作成功:
1{
2 "nextMarker": "rc-Iy8p6arqenI7",
3 "marker": "rc-ik9p9zq6u5ry",
4 "maxKeys": 1,
5 "isTruncated": true,
6 "records": [{
7 "recordId": "rc-djkf8hf9",
8 "rr": "ip",
9 "value": "192.184.18.233",
10 "status": "enable",
11 "type": "A",
12 "ttl": 60,
13 "description": "desc"
14 }]
15}
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_list_record.go
开启解析记录
函数声明
1func (c *Client) EnableRecord(recordId string, clientToken string) error
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Bkk6m60y1
返回值
操作成功:
1// 无返回body
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_enable_record.go
暂停解析记录
函数声明
1func (c *Client) DisableRecord(recordId string, clientToken string) error
参数含义
请参考OpenApi文档:https://cloud.baidu.com/doc/DNS/s/Bkk6m60y1
返回值
操作成功:
1// 无返回body
操作失败:
抛出异常,异常列表参考:内网dns异常列表
代码示例
具体代码示例参考:example_disable_record.go