内网DNS

更新时间：2024-01-10

初始化

确认Endpoint

内网DNS API 的服务域名为：privatezone.baidubce.com

API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性，建议通过HTTPS调用。

获取密钥

要使用百度云LD，您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的，均为字符串，用于标识用户，为访问LD做签名验证。

可以通过如下步骤获得并了解您的AK/SK信息：

注册百度云账号

创建AK/SK

新建LD Client

LD Client是LD服务的客户端，为开发者与LD服务进行交互提供了一系列的方法。

使用AK/SK新建LD Client

通过AK/SK方式访问LD，用户可以参考如下代码新建一个LD Client：

import (
	"github.com/baidubce/bce-sdk-go/services/localDns"
)

func main() {
	// 用户的Access Key ID和Secret Access Key
	ACCESS_KEY_ID, SECRET_ACCESS_KEY := <your-access-key-id>, <your-secret-access-key>
	
	// 用户指定的Endpoint
	ENDPOINT := <domain-name>

	// 初始化一个LDClient
	ldClient, err := ld.NewClient(AK, SK, ENDPOINT)
}

在上面代码中，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对象：

import (
	"fmt"

	"github.com/baidubce/bce-sdk-go/auth"         //导入认证模块
	"github.com/baidubce/bce-sdk-go/services/localDns" //导入LD服务模块
	"github.com/baidubce/bce-sdk-go/services/sts" //导入STS服务模块
)

func main() {
	// 创建STS服务的Client对象，Endpoint使用默认值
	AK, SK := <your-access-key-id>, <your-secret-access-key>
	stsClient, err := sts.NewClient(AK, SK)
	if err != nil {
		fmt.Println("create sts client object :", err)
		return
	}

	// 获取临时认证token，有效期为60秒，ACL为空
	stsObj, err := stsClient.GetSessionToken(60, "")
	if err != nil {
		fmt.Println("get session token failed:", err)
		return
    }
	fmt.Println("GetSessionToken result:")
	fmt.Println("  accessKeyId:", stsObj.AccessKeyId)
	fmt.Println("  secretAccessKey:", stsObj.SecretAccessKey)
	fmt.Println("  sessionToken:", stsObj.SessionToken)
	fmt.Println("  createTime:", stsObj.CreateTime)
	fmt.Println("  expiration:", stsObj.Expiration)
	fmt.Println("  userId:", stsObj.UserId)

	// 使用申请的临时STS创建LD服务的Client对象，Endpoint使用默认值
	ldClient, err := ld.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "privatezone.baidubce.com")
	if err != nil {
		fmt.Println("create localDns client failed:", err)
		return
	}
	stsCredential, err := auth.NewSessionBceCredentials(
		stsObj.AccessKeyId,
		stsObj.SecretAccessKey,
		stsObj.SessionToken)
	if err != nil {
		fmt.Println("create sts credential object failed:", err)
		return
	}
	ldClient.Config.Credentials = stsCredential
}

注意：目前使用STS配置LD Client时，STS的Endpoint需配置为http://sts.bj.baidubce.com。

配置HTTPS协议访问LD

LD支持HTTPS传输协议，您可以通过在创建LD Client对象时指定的Endpoint中指明HTTPS的方式，在LD GO SDK中使用HTTPS访问LD服务：

// import "github.com/baidubce/bce-sdk-go/services/localDns"

ENDPOINT := "https://privatezone.baidubce.com	" //指明使用HTTPS协议
AK, SK := <your-access-key-id>, <your-secret-access-key>
ldClient, _ := ld.NewClient(AK, SK, ENDPOINT)

配置LD Client

如果用户需要配置LD Client的一些细节的参数，可以在创建LD Client对象之后，使用该对象的导出字段Config进行自定义配置，可以为客户端配置代理，最大连接数等参数。

使用代理

下面一段代码可以让客户端使用代理访问LD服务：

// import "github.com/baidubce/bce-sdk-go/services/localDns"

//创建LD Client对象
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "privatezone.baidubce.com"
client, _ := ld.NewClient(AK, SK, ENDPOINT)

//代理使用本地的8080端口
client.Config.ProxyUrl = "127.0.0.1:8080"

设置网络参数

用户可以通过如下的示例代码进行网络参数的设置：

// import "github.com/baidubce/bce-sdk-go/services/localDns"

AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "privatezone.baidubce.com"
client, _ := ld.NewClient(AK, SK, ENDPOINT)

// 配置不进行重试，默认为Back Off重试
client.Config.Retry = bce.NewNoRetryPolicy()

// 配置连接超时时间为30秒
client.Config.ConnectionTimeoutInMillis = 30 * 1000

配置生成签名字符串选项

// import "github.com/baidubce/bce-sdk-go/services/localDns"

AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "privatezone.baidubce.com"
client, _ := ld.NewClient(AK, SK, ENDPOINT)

// 配置签名使用的HTTP请求头为`Host`
headersToSign := map[string]struct{}{"Host": struct{}{}}
client.Config.SignOption.HeadersToSign = HeadersToSign

// 配置签名的有效期为30秒
client.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

函数声明

type CreatePrivateZoneRequest struct {
	ClientToken string `json:"-"`
	ZoneName    string `json:"zoneName"`
}

type CreatePrivateZoneResponse struct {
	ZoneId string `json:"zoneId"`
}

func (c *Client) CreatePrivateZone(body *CreatePrivateZoneRequest) (*CreatePrivateZoneResponse, error)

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/jkk6kkh7x

返回值
操作成功：

{
   "zoneId":"zone-jkgdns3h"
}

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_create_private_zone.go

删除PrivateZone

函数声明

func (c *Client) DeletePrivateZone(zoneId string, clientToken string) error

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Kkk6kpur9

返回值
操作成功：

// 无返回body

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_delete_private_zone.go

查询PrivateZone列表

函数声明

type ListPrivateZoneRequest struct {
	Marker  string
	MaxKeys int
}

type ListPrivateZoneResponse struct {
	Marker      string `json:"marker"`
	IsTruncated bool   `json:"isTruncated"`
	NextMarker  string `json:"nextMarker"`
	MaxKeys     int32  `json:"maxKeys"`
	Zones       []Zone `json:"zones"`
}

func (c *Client) ListPrivateZone(request *ListPrivateZoneRequest) (*ListPrivateZoneResponse, error)

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Bkk6l42dl

返回值
操作成功：

{
    "nextMarker": "zone-xktdeMSf",
    "marker": "zone-IyWRnII7",
    "maxKeys": 1,
    "isTruncated": true,
    "zones": [{
        "zoneId": "zone-IyWRnII7",
        "zoneName": "baidu.com",
        "recordCount": 2,
        "createTime": "2018-12-26 20:30:45",
        "updateTime": "2018-12-28 21:35:40"
    }]
}

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_list_private_zone.go

查询PrivateZone详情

函数声明

type GetPrivateZoneResponse struct {
	ZoneId      string `json:"zoneId"`
	ZoneName    string `json:"zoneName"`
	RecordCount int32  `json:"recordCount"`
	CreateTime  string `json:"createTime"`
	UpdateTime  string `json:"updateTime"`
	BindVpcs    []Vpc  `json:"bindVpcs"`
}

func (c *Client) GetPrivateZone(zoneId string) (*GetPrivateZoneResponse, error)

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Jkk6lc8li

返回值
操作成功：

{
    "zoneId": "zone-xktdeMSf",
    "zoneName": "baidu1.com",
    "recordCount": 2,
    "createTime": "2018-12-26 20:30:45",
    "updateTime": "2018-12-28 21:35:40"
    "bindVpcs": [{
        "vpcId": "vpc-jikh8hds",
        "vpcName": "vpcTest",
        "vpcRegion": "bj"
    }]
}

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_get_private_zone.go

关联VPC

函数声明

type BindVpcRequest struct {
	ClientToken string   `json:"-"`
	Region      string   `json:"region"`
	VpcIds      []string `json:"vpcIds"`
}


func (c *Client) BindVpc(zoneId string, body *BindVpcRequest) error

参数含义
请参考OpenApi文档： https://cloud.baidu.com/doc/DNS/s/qkk6lg1af

返回值
操作成功：

// 无返回body

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_bind_vpc.go

解关联VPC

函数声明

type UnbindVpcRequest struct {
	ClientToken string   `json:"-"`
	Region      string   `json:"region"`
	VpcIds      []string `json:"vpcIds"`
}

func (c *Client) UnbindVpc(zoneId string, body *UnbindVpcRequest) error

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Dkk6lkyy1

返回值
操作成功：

// 无返回body

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_unbind_vpc.go

添加解析记录

函数声明

type AddRecordRequest struct {
	ClientToken string `json:"-"`
	Rr          string `json:"rr"`
	Value       string `json:"value"`
	Type        string `json:"type"`
	Ttl         int32  `json:"ttl,omitempty"`
	Priority    int32  `json:"priority,omitempty"`
	Description string `json:"description,omitempty"`
}

type AddRecordResponse struct {
	RecordId string `json:"recordId"`
}

func (c *Client) AddRecord(zoneId string, body *AddRecordRequest) (*AddRecordResponse, error)

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Pkk6lpe4e

返回值
操作成功：

{
  "recordId":"rc-jih8hd5s"
}

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_add_record.go

修改解析记录

函数声明

type UpdateRecordRequest struct {
	ClientToken string `json:"-"`
	Rr          string `json:"rr"`
	Value       string `json:"value"`
	Type        string `json:"type"`
	Ttl         int32  `json:"ttl,omitempty"`
	Priority    int32  `json:"priority,omitempty"`
	Description string `json:"description,omitempty"`
}

func (c *Client) UpdateRecord(recordId string, body *UpdateRecordRequest) error

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Dkk6lu5ds

返回值
操作成功：

// 无返回body

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_update_record.go

删除解析记录

函数声明

func (c *Client) DeleteRecord(recordId string, clientToken string) error

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Lkk6lx4f1

返回值
操作成功：

// 无返回body

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_delete_record.go

查询解析记录列表

函数声明

type ListRecordResponse struct {
	Marker      string   `json:"marker"`
	IsTruncated bool     `json:"isTruncated"`
	NextMarker  string   `json:"nextMarker"`
	MaxKeys     int32    `json:"maxKeys"`
	Records     []Record `json:"records"`
}

func (c *Client) ListRecord(zoneId string) (*ListRecordResponse, error)

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Ckk6m3d7a

返回值
操作成功：

{
    "nextMarker": "rc-Iy8p6arqenI7",
    "marker": "rc-ik9p9zq6u5ry",
    "maxKeys": 1,
    "isTruncated": true,
    "records": [{
        "recordId": "rc-djkf8hf9",
        "rr": "ip",
        "value": "192.184.18.233",
        "status": "enable",
        "type": "A",
        "ttl": 60,
        "description": "desc"
    }]
}

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_list_record.go

开启解析记录

函数声明

func (c *Client) EnableRecord(recordId string, clientToken string) error

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Bkk6m60y1

返回值
操作成功：

// 无返回body

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_enable_record.go

暂停解析记录

函数声明

func (c *Client) DisableRecord(recordId string, clientToken string) error

参数含义
请参考OpenApi文档：https://cloud.baidu.com/doc/DNS/s/Bkk6m60y1

返回值
操作成功：

// 无返回body

操作失败：

抛出异常，异常列表参考：内网dns异常列表

代码示例
具体代码示例参考：example_disable_record.go

初始化

异常处理

百度智能云

智能云解析 DNS

智能云解析 DNS

内网DNS

初始化

确认Endpoint

获取密钥

新建LD Client

使用AK/SK新建LD Client

使用STS创建LD Client

配置HTTPS协议访问LD

配置LD Client

使用代理

设置网络参数

配置生成签名字符串选项

创建PrivateZone

删除PrivateZone

查询PrivateZone列表

查询PrivateZone详情

关联VPC

解关联VPC

添加解析记录

修改解析记录

删除解析记录

查询解析记录列表

开启解析记录

暂停解析记录