Blame - docs/dyn/dns_v1.managedZones.html - platform/external/python/google-api-python-client

2015-06-15 16:44:50 +0000

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

75

<h1><a href="dns_v1.html">Cloud DNS API</a> . <a href="dns_v1.managedZones.html">managedZones</a></h1>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

78

<code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Create a new ManagedZone.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

81

<code><a href="#delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Delete a previously created ManagedZone.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

83

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

84

<code><a href="#get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Fetch the representation of an existing ManagedZone.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

86

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

87

<code><a href="#list">list(project, dnsName=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Enumerate ManagedZones that have been created but not yet deleted.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

93

<code><a href="#patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Apply a partial update to an existing ManagedZone.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

96

<code><a href="#update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Update an existing ManagedZone.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

98

<h3>Method Details</h3>

99

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

100

<code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>

101

<pre>Create a new ManagedZone.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

102

103

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

104

project: string, Identifies the project addressed by this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

106

The object takes the form of:

107

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

108

{ # A zone is a subtree of the DNS namespace under one administrative

109

# responsibility. A ManagedZone is a resource that represents a DNS zone

110

# hosted by the Cloud DNS service.

111

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

112

# text format. Output only.

113

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

114

# zone. The value of this field contains the network to peer with.

115

"kind": "dns#managedZonePeeringConfig",

116

"targetNetwork": { # The network with which to peer.

117

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

118

# format. An empty string indicates that the peering connection is

119

# active. The producer network can deactivate a zone. The zone is

120

# automatically deactivated if the producer network that the zone

121

# targeted is deleted. Output only.

122

"kind": "dns#managedZonePeeringConfigTargetNetwork",

123

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

124

# This should be formatted like

125

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

126

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

128

"dnssecConfig": { # DNSSEC configuration.

129

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

130

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

131

# Can only be changed while the state is OFF.

132

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

133

# ManagedZone. Can only be changed while the state is OFF.

134

{ # Parameters for DnsKey key generation. Used for generating initial keys

135

# for a new ManagedZone and as default when adding a new DnsKey.

136

"keyLength": 42, # Length of the keys in bits.

137

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

138

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

139

# active, will only be used to sign resource record sets of type DNSKEY.

140

# Zone signing keys do not have the Secure Entry Point flag set and will be

141

# used to sign all other types of resource record sets.

142

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

143

"kind": "dns#dnsKeySpec",

144

},

145

],

146

"kind": "dns#managedZoneDnsSecConfig",

147

},

148

"name": "A String", # User assigned name for this resource. Must be unique within the project.

149

# The name must be 1-63 characters long, must begin with a letter, end with

150

# a letter or digit, and only contain lowercase letters, digits or dashes.

151

"labels": { # User labels.

152

"a_key": "A String",

153

},

154

"kind": "dns#managedZone",

155

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

156

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

157

# private zones are visible only to Virtual Private Cloud resources.

158

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

159

# that the zone is visible from.

160

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

161

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

162

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

163

# This should be formatted like

164

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

165

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

166

},

167

],

168

"kind": "dns#managedZonePrivateVisibilityConfig",

169

},

170

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

171

# NameServerSet is a set of DNS name servers that all host the same

172

# ManagedZones. Most users will leave this field unset.

173

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

174

# for this zone. The value of this field contains the set of destinations

175

# to forward to.

176

"kind": "dns#managedZoneForwardingConfig",

177

"targetNameServers": [ # List of target name servers to forward to.

178

# Cloud DNS will select the best available name server if more than one

179

# target is given.

180

{

181

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

182

"ipv4Address": "A String", # IPv4 address of a target name server.

183

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

184

# Cloud DNS will make forwarding decision based on address ranges,

185

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

186

# Internet. When set to PRIVATE, Cloud DNS will always send queries

187

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

188

},

189

],

190

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

191

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

192

# server (output only)

193

"A String",

194

],

195

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

196

# lookup zone and Cloud DNS will resolve reverse lookup queries using

197

# automatically configured records for VPC resources. This only applies

198

# to networks listed under private_visibility_config.

199

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

200

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

201

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

202

# for the user's convenience. Has no effect on the managed zone's function.

203

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

204

}

205

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

206

clientOperationId: string, For mutating operation requests only. An optional identifier

207

specified by the client. Must be unique for operation resources in the

208

Operations collection.

209

x__xgafv: string, V1 error format.

210

Allowed values

211

1 - v1 error format

212

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

213

214

Returns:

215

An object of the form:

216

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

217

{ # A zone is a subtree of the DNS namespace under one administrative

218

# responsibility. A ManagedZone is a resource that represents a DNS zone

219

# hosted by the Cloud DNS service.

220

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

221

# text format. Output only.

222

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

223

# zone. The value of this field contains the network to peer with.

224

"kind": "dns#managedZonePeeringConfig",

225

"targetNetwork": { # The network with which to peer.

226

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

227

# format. An empty string indicates that the peering connection is

228

# active. The producer network can deactivate a zone. The zone is

229

# automatically deactivated if the producer network that the zone

230

# targeted is deleted. Output only.

231

"kind": "dns#managedZonePeeringConfigTargetNetwork",

232

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

233

# This should be formatted like

234

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

235

},

236

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

237

"dnssecConfig": { # DNSSEC configuration.

238

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

239

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

240

# Can only be changed while the state is OFF.

241

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

242

# ManagedZone. Can only be changed while the state is OFF.

243

{ # Parameters for DnsKey key generation. Used for generating initial keys

244

# for a new ManagedZone and as default when adding a new DnsKey.

245

"keyLength": 42, # Length of the keys in bits.

246

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

247

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

248

# active, will only be used to sign resource record sets of type DNSKEY.

249

# Zone signing keys do not have the Secure Entry Point flag set and will be

250

# used to sign all other types of resource record sets.

251

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

252

"kind": "dns#dnsKeySpec",

253

},

254

],

255

"kind": "dns#managedZoneDnsSecConfig",

256

},

257

"name": "A String", # User assigned name for this resource. Must be unique within the project.

258

# The name must be 1-63 characters long, must begin with a letter, end with

259

# a letter or digit, and only contain lowercase letters, digits or dashes.

260

"labels": { # User labels.

261

"a_key": "A String",

262

},

263

"kind": "dns#managedZone",

264

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

265

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

266

# private zones are visible only to Virtual Private Cloud resources.

267

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

268

# that the zone is visible from.

269

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

270

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

271

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

272

# This should be formatted like

273

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

274

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

275

},

276

],

277

"kind": "dns#managedZonePrivateVisibilityConfig",

278

},

279

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

280

# NameServerSet is a set of DNS name servers that all host the same

281

# ManagedZones. Most users will leave this field unset.

282

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

283

# for this zone. The value of this field contains the set of destinations

284

# to forward to.

285

"kind": "dns#managedZoneForwardingConfig",

286

"targetNameServers": [ # List of target name servers to forward to.

287

# Cloud DNS will select the best available name server if more than one

288

# target is given.

289

{

290

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

291

"ipv4Address": "A String", # IPv4 address of a target name server.

292

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

293

# Cloud DNS will make forwarding decision based on address ranges,

294

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

295

# Internet. When set to PRIVATE, Cloud DNS will always send queries

296

# through VPC for this target

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

297

},

298

],

299

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

300

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

301

# server (output only)

302

"A String",

303

],

304

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

305

# lookup zone and Cloud DNS will resolve reverse lookup queries using

306

# automatically configured records for VPC resources. This only applies

307

# to networks listed under private_visibility_config.

308

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

309

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

310

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

311

# for the user's convenience. Has no effect on the managed zone's function.

312

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

317

<code class="details" id="delete">delete(project, managedZone, clientOperationId=None, x__xgafv=None)</code>

318

<pre>Delete a previously created ManagedZone.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

319

320

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

321

project: string, Identifies the project addressed by this request. (required)

322

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed

323

zone name or id. (required)

324

clientOperationId: string, For mutating operation requests only. An optional identifier

325

specified by the client. Must be unique for operation resources in the

326

Operations collection.

327

x__xgafv: string, V1 error format.

328

Allowed values

329

1 - v1 error format

330

2 - v2 error format

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

335

<code class="details" id="get">get(project, managedZone, clientOperationId=None, x__xgafv=None)</code>

336

<pre>Fetch the representation of an existing ManagedZone.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

337

338

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

339

project: string, Identifies the project addressed by this request. (required)

340

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed

341

zone name or id. (required)

342

clientOperationId: string, For mutating operation requests only. An optional identifier

343

specified by the client. Must be unique for operation resources in the

344

Operations collection.

345

x__xgafv: string, V1 error format.

346

Allowed values

347

1 - v1 error format

348

2 - v2 error format

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

349

350

Returns:

351

An object of the form:

352

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

353

{ # A zone is a subtree of the DNS namespace under one administrative

354

# responsibility. A ManagedZone is a resource that represents a DNS zone

355

# hosted by the Cloud DNS service.

356

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

357

# text format. Output only.

358

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

359

# zone. The value of this field contains the network to peer with.

360

"kind": "dns#managedZonePeeringConfig",

361

"targetNetwork": { # The network with which to peer.

362

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

363

# format. An empty string indicates that the peering connection is

364

# active. The producer network can deactivate a zone. The zone is

365

# automatically deactivated if the producer network that the zone

366

# targeted is deleted. Output only.

367

"kind": "dns#managedZonePeeringConfigTargetNetwork",

368

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

369

# This should be formatted like

370

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

371

},

372

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

373

"dnssecConfig": { # DNSSEC configuration.

374

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

375

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

376

# Can only be changed while the state is OFF.

377

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

378

# ManagedZone. Can only be changed while the state is OFF.

379

{ # Parameters for DnsKey key generation. Used for generating initial keys

380

# for a new ManagedZone and as default when adding a new DnsKey.

381

"keyLength": 42, # Length of the keys in bits.

382

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

383

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

384

# active, will only be used to sign resource record sets of type DNSKEY.

385

# Zone signing keys do not have the Secure Entry Point flag set and will be

386

# used to sign all other types of resource record sets.

387

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

388

"kind": "dns#dnsKeySpec",

389

},

390

],

391

"kind": "dns#managedZoneDnsSecConfig",

392

},

393

"name": "A String", # User assigned name for this resource. Must be unique within the project.

394

# The name must be 1-63 characters long, must begin with a letter, end with

395

# a letter or digit, and only contain lowercase letters, digits or dashes.

396

"labels": { # User labels.

397

"a_key": "A String",

398

},

399

"kind": "dns#managedZone",

400

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

401

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

402

# private zones are visible only to Virtual Private Cloud resources.

403

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

404

# that the zone is visible from.

405

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

406

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

407

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

408

# This should be formatted like

409

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

410

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

411

},

412

],

413

"kind": "dns#managedZonePrivateVisibilityConfig",

414

},

415

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

416

# NameServerSet is a set of DNS name servers that all host the same

417

# ManagedZones. Most users will leave this field unset.

418

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

419

# for this zone. The value of this field contains the set of destinations

420

# to forward to.

421

"kind": "dns#managedZoneForwardingConfig",

422

"targetNameServers": [ # List of target name servers to forward to.

423

# Cloud DNS will select the best available name server if more than one

424

# target is given.

425

{

426

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

427

"ipv4Address": "A String", # IPv4 address of a target name server.

428

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

429

# Cloud DNS will make forwarding decision based on address ranges,

430

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

431

# Internet. When set to PRIVATE, Cloud DNS will always send queries

432

# through VPC for this target

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

433

},

434

],

435

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

436

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

437

# server (output only)

438

"A String",

439

],

440

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

441

# lookup zone and Cloud DNS will resolve reverse lookup queries using

442

# automatically configured records for VPC resources. This only applies

443

# to networks listed under private_visibility_config.

444

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

445

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

446

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

447

# for the user's convenience. Has no effect on the managed zone's function.

448

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

453

<code class="details" id="list">list(project, dnsName=None, pageToken=None, maxResults=None, x__xgafv=None)</code>

454

<pre>Enumerate ManagedZones that have been created but not yet deleted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

455

456

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

457

project: string, Identifies the project addressed by this request. (required)

458

dnsName: string, Restricts the list to return only zones with this domain name.

459

pageToken: string, Optional. A tag returned by a previous list request that was truncated.

460

Use this parameter to continue a previous list request.

461

maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the

462

server will decide how many results to return.

463

x__xgafv: string, V1 error format.

464

Allowed values

465

1 - v1 error format

466

2 - v2 error format

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

467

468

Returns:

469

An object of the form:

470

471

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

472

"nextPageToken": "A String", # The presence of this field indicates that there exist more results

473

# following your last page of results in pagination order. To fetch them,

474

# make another list request using this value as your page token.

475

#

476

# In this way you can retrieve the complete contents of even very large

477

# collections one page at a time. However, if the contents of the collection

478

# change between the first and last paginated list request, the set of all

479

# elements returned will be an inconsistent view of the collection. There is

480

# no way to retrieve a consistent snapshot of a collection larger than the

481

# maximum page size.

482

"header": { # Elements common to every response.

483

"operationId": "A String", # For mutating operation requests that completed successfully.

484

# This is the client_operation_id if the client specified it,

485

# otherwise it is generated by the server (output only).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

486

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

487

"kind": "dns#managedZonesListResponse", # Type of resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

488

"managedZones": [ # The managed zone resources.

489

{ # A zone is a subtree of the DNS namespace under one administrative

490

# responsibility. A ManagedZone is a resource that represents a DNS zone

491

# hosted by the Cloud DNS service.

492

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

493

# text format. Output only.

494

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

495

# zone. The value of this field contains the network to peer with.

496

"kind": "dns#managedZonePeeringConfig",

497

"targetNetwork": { # The network with which to peer.

498

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

499

# format. An empty string indicates that the peering connection is

500

# active. The producer network can deactivate a zone. The zone is

501

# automatically deactivated if the producer network that the zone

502

# targeted is deleted. Output only.

503

"kind": "dns#managedZonePeeringConfigTargetNetwork",

504

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

505

# This should be formatted like

506

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

507

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

508

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

509

"dnssecConfig": { # DNSSEC configuration.

510

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

511

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

512

# Can only be changed while the state is OFF.

513

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

514

# ManagedZone. Can only be changed while the state is OFF.

515

{ # Parameters for DnsKey key generation. Used for generating initial keys

516

# for a new ManagedZone and as default when adding a new DnsKey.

517

"keyLength": 42, # Length of the keys in bits.

518

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

519

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

520

# active, will only be used to sign resource record sets of type DNSKEY.

521

# Zone signing keys do not have the Secure Entry Point flag set and will be

522

# used to sign all other types of resource record sets.

523

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

524

"kind": "dns#dnsKeySpec",

525

},

526

],

527

"kind": "dns#managedZoneDnsSecConfig",

528

},

529

"name": "A String", # User assigned name for this resource. Must be unique within the project.

530

# The name must be 1-63 characters long, must begin with a letter, end with

531

# a letter or digit, and only contain lowercase letters, digits or dashes.

532

"labels": { # User labels.

533

"a_key": "A String",

534

},

535

"kind": "dns#managedZone",

536

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

537

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

538

# private zones are visible only to Virtual Private Cloud resources.

539

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

540

# that the zone is visible from.

541

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

542

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

543

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

544

# This should be formatted like

545

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

546

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

547

},

548

],

549

"kind": "dns#managedZonePrivateVisibilityConfig",

550

},

551

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

552

# NameServerSet is a set of DNS name servers that all host the same

553

# ManagedZones. Most users will leave this field unset.

554

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

555

# for this zone. The value of this field contains the set of destinations

556

# to forward to.

557

"kind": "dns#managedZoneForwardingConfig",

558

"targetNameServers": [ # List of target name servers to forward to.

559

# Cloud DNS will select the best available name server if more than one

560

# target is given.

561

{

562

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

563

"ipv4Address": "A String", # IPv4 address of a target name server.

564

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

565

# Cloud DNS will make forwarding decision based on address ranges,

566

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

567

# Internet. When set to PRIVATE, Cloud DNS will always send queries

568

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

569

},

570

],

571

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

572

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

573

# server (output only)

574

"A String",

575

],

576

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

577

# lookup zone and Cloud DNS will resolve reverse lookup queries using

578

# automatically configured records for VPC resources. This only applies

579

# to networks listed under private_visibility_config.

580

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

581

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

582

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

583

# for the user's convenience. Has no effect on the managed zone's function.

584

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

585

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

592

<pre>Retrieves the next page of results.

593

594

Args:

595

previous_request: The request for the previous page. (required)

596

previous_response: The response from the request for the previous page. (required)

597

598

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

599

A request object that you can call 'execute()' on to request the next

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

600

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

604

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

605

<code class="details" id="patch">patch(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>

606

<pre>Apply a partial update to an existing ManagedZone.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

607

608

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

609

project: string, Identifies the project addressed by this request. (required)

610

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed

611

zone name or id. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

612

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

613

The object takes the form of:

614

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

615

{ # A zone is a subtree of the DNS namespace under one administrative

616

# responsibility. A ManagedZone is a resource that represents a DNS zone

617

# hosted by the Cloud DNS service.

618

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

619

# text format. Output only.

620

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

621

# zone. The value of this field contains the network to peer with.

622

"kind": "dns#managedZonePeeringConfig",

623

"targetNetwork": { # The network with which to peer.

624

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

625

# format. An empty string indicates that the peering connection is

626

# active. The producer network can deactivate a zone. The zone is

627

# automatically deactivated if the producer network that the zone

628

# targeted is deleted. Output only.

629

"kind": "dns#managedZonePeeringConfigTargetNetwork",

630

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

631

# This should be formatted like

632

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

633

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

634

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

635

"dnssecConfig": { # DNSSEC configuration.

636

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

637

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

638

# Can only be changed while the state is OFF.

639

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

640

# ManagedZone. Can only be changed while the state is OFF.

641

{ # Parameters for DnsKey key generation. Used for generating initial keys

642

# for a new ManagedZone and as default when adding a new DnsKey.

643

"keyLength": 42, # Length of the keys in bits.

644

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

645

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

646

# active, will only be used to sign resource record sets of type DNSKEY.

647

# Zone signing keys do not have the Secure Entry Point flag set and will be

648

# used to sign all other types of resource record sets.

649

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

650

"kind": "dns#dnsKeySpec",

651

},

652

],

653

"kind": "dns#managedZoneDnsSecConfig",

654

},

655

"name": "A String", # User assigned name for this resource. Must be unique within the project.

656

# The name must be 1-63 characters long, must begin with a letter, end with

657

# a letter or digit, and only contain lowercase letters, digits or dashes.

658

"labels": { # User labels.

659

"a_key": "A String",

660

},

661

"kind": "dns#managedZone",

662

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

663

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

664

# private zones are visible only to Virtual Private Cloud resources.

665

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

666

# that the zone is visible from.

667

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

668

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

669

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

670

# This should be formatted like

671

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

672

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

673

},

674

],

675

"kind": "dns#managedZonePrivateVisibilityConfig",

676

},

677

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

678

# NameServerSet is a set of DNS name servers that all host the same

679

# ManagedZones. Most users will leave this field unset.

680

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

681

# for this zone. The value of this field contains the set of destinations

682

# to forward to.

683

"kind": "dns#managedZoneForwardingConfig",

684

"targetNameServers": [ # List of target name servers to forward to.

685

# Cloud DNS will select the best available name server if more than one

686

# target is given.

687

{

688

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

689

"ipv4Address": "A String", # IPv4 address of a target name server.

690

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

691

# Cloud DNS will make forwarding decision based on address ranges,

692

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

693

# Internet. When set to PRIVATE, Cloud DNS will always send queries

694

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

695

},

696

],

697

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

698

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

699

# server (output only)

700

"A String",

701

],

702

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

703

# lookup zone and Cloud DNS will resolve reverse lookup queries using

704

# automatically configured records for VPC resources. This only applies

705

# to networks listed under private_visibility_config.

706

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

707

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

708

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

709

# for the user's convenience. Has no effect on the managed zone's function.

710

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

711

}

712

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

713

clientOperationId: string, For mutating operation requests only. An optional identifier

714

specified by the client. Must be unique for operation resources in the

715

Operations collection.

716

x__xgafv: string, V1 error format.

717

Allowed values

718

1 - v1 error format

719

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

720

721

Returns:

722

An object of the form:

723

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

724

{ # An operation represents a successful mutation performed on a Cloud DNS

725

# resource.

726

# Operations provide:

727

# - An audit log of server resource mutations.

728

# - A way to recover/retry API calls in the case where the response is never

729

# received by the caller. Use the caller specified client_operation_id.

730

"type": "A String", # Type of the operation. Operations include insert, update, and delete

731

# (output only).

732

"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).

733

"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.

734

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

735

# for the user's convenience. Has no effect on the resource's function.

736

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

737

# DnsKey. These digests are needed to construct a DS record that points at

738

# this DNS key. Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

739

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

740

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS

741

# resource record.

742

"type": "A String", # Specifies the algorithm used to calculate this digest.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

743

},

744

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

745

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

746

# Secure Entry Point flag set and, when active, will be used to sign only

747

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

748

# flag will be cleared and this key will be used to sign only resource

749

# record sets of other types. Immutable after creation time.

750

"creationTime": "A String", # The time that this resource was created in the control plane. This is in

751

# RFC3339 text format. Output only.

752

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

753

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

754

# Inactive keys will still be present as DNSKEY Resource Records for the use

755

# of resolvers validating existing signatures.

756

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

757

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

758

# more quickly (but it is not a unique identifier). In particular, the key

759

# tag is used in a parent zone's DS record to point at the DNSKEY in this

760

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

761

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

762

"kind": "dns#dnsKey",

763

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

764

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

765

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable

766

# after creation time.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

767

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

768

"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.

769

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

770

# for the user's convenience. Has no effect on the resource's function.

771

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

772

# DnsKey. These digests are needed to construct a DS record that points at

773

# this DNS key. Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

774

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

775

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS

776

# resource record.

777

"type": "A String", # Specifies the algorithm used to calculate this digest.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

778

},

779

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

780

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

781

# Secure Entry Point flag set and, when active, will be used to sign only

782

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

783

# flag will be cleared and this key will be used to sign only resource

784

# record sets of other types. Immutable after creation time.

785

"creationTime": "A String", # The time that this resource was created in the control plane. This is in

786

# RFC3339 text format. Output only.

787

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

788

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

789

# Inactive keys will still be present as DNSKEY Resource Records for the use

790

# of resolvers validating existing signatures.

791

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

792

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

793

# more quickly (but it is not a unique identifier). In particular, the key

794

# tag is used in a parent zone's DS record to point at the DNSKEY in this

795

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

796

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

797

"kind": "dns#dnsKey",

798

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

799

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

800

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable

801

# after creation time.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

802

},

803

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

804

"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).

805

"newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource.

806

# responsibility. A ManagedZone is a resource that represents a DNS zone

807

# hosted by the Cloud DNS service.

808

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

809

# text format. Output only.

810

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

811

# zone. The value of this field contains the network to peer with.

812

"kind": "dns#managedZonePeeringConfig",

813

"targetNetwork": { # The network with which to peer.

814

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

815

# format. An empty string indicates that the peering connection is

816

# active. The producer network can deactivate a zone. The zone is

817

# automatically deactivated if the producer network that the zone

818

# targeted is deleted. Output only.

819

"kind": "dns#managedZonePeeringConfigTargetNetwork",

820

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

821

# This should be formatted like

822

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

823

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

824

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

825

"dnssecConfig": { # DNSSEC configuration.

826

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

827

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

828

# Can only be changed while the state is OFF.

829

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

830

# ManagedZone. Can only be changed while the state is OFF.

831

{ # Parameters for DnsKey key generation. Used for generating initial keys

832

# for a new ManagedZone and as default when adding a new DnsKey.

833

"keyLength": 42, # Length of the keys in bits.

834

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

835

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

836

# active, will only be used to sign resource record sets of type DNSKEY.

837

# Zone signing keys do not have the Secure Entry Point flag set and will be

838

# used to sign all other types of resource record sets.

839

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

840

"kind": "dns#dnsKeySpec",

841

},

842

],

843

"kind": "dns#managedZoneDnsSecConfig",

844

},

845

"name": "A String", # User assigned name for this resource. Must be unique within the project.

846

# The name must be 1-63 characters long, must begin with a letter, end with

847

# a letter or digit, and only contain lowercase letters, digits or dashes.

848

"labels": { # User labels.

849

"a_key": "A String",

850

},

851

"kind": "dns#managedZone",

852

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

853

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

854

# private zones are visible only to Virtual Private Cloud resources.

855

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

856

# that the zone is visible from.

857

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

858

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

859

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

860

# This should be formatted like

861

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

862

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

863

},

864

],

865

"kind": "dns#managedZonePrivateVisibilityConfig",

866

},

867

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

868

# NameServerSet is a set of DNS name servers that all host the same

869

# ManagedZones. Most users will leave this field unset.

870

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

871

# for this zone. The value of this field contains the set of destinations

872

# to forward to.

873

"kind": "dns#managedZoneForwardingConfig",

874

"targetNameServers": [ # List of target name servers to forward to.

875

# Cloud DNS will select the best available name server if more than one

876

# target is given.

877

{

878

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

879

"ipv4Address": "A String", # IPv4 address of a target name server.

880

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

881

# Cloud DNS will make forwarding decision based on address ranges,

882

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

883

# Internet. When set to PRIVATE, Cloud DNS will always send queries

884

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

885

},

886

],

887

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

888

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

889

# server (output only)

890

"A String",

891

],

892

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

893

# lookup zone and Cloud DNS will resolve reverse lookup queries using

894

# automatically configured records for VPC resources. This only applies

895

# to networks listed under private_visibility_config.

896

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

897

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

898

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

899

# for the user's convenience. Has no effect on the managed zone's function.

900

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

901

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

902

"oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource.

903

# responsibility. A ManagedZone is a resource that represents a DNS zone

904

# hosted by the Cloud DNS service.

905

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

906

# text format. Output only.

907

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

908

# zone. The value of this field contains the network to peer with.

909

"kind": "dns#managedZonePeeringConfig",

910

"targetNetwork": { # The network with which to peer.

911

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

912

# format. An empty string indicates that the peering connection is

913

# active. The producer network can deactivate a zone. The zone is

914

# automatically deactivated if the producer network that the zone

915

# targeted is deleted. Output only.

916

"kind": "dns#managedZonePeeringConfigTargetNetwork",

917

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

918

# This should be formatted like

919

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

920

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

921

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

922

"dnssecConfig": { # DNSSEC configuration.

923

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

924

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

925

# Can only be changed while the state is OFF.

926

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

927

# ManagedZone. Can only be changed while the state is OFF.

928

{ # Parameters for DnsKey key generation. Used for generating initial keys

929

# for a new ManagedZone and as default when adding a new DnsKey.

930

"keyLength": 42, # Length of the keys in bits.

931

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

932

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

933

# active, will only be used to sign resource record sets of type DNSKEY.

934

# Zone signing keys do not have the Secure Entry Point flag set and will be

935

# used to sign all other types of resource record sets.

936

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

937

"kind": "dns#dnsKeySpec",

938

},

939

],

940

"kind": "dns#managedZoneDnsSecConfig",

941

},

942

"name": "A String", # User assigned name for this resource. Must be unique within the project.

943

# The name must be 1-63 characters long, must begin with a letter, end with

944

# a letter or digit, and only contain lowercase letters, digits or dashes.

945

"labels": { # User labels.

946

"a_key": "A String",

947

},

948

"kind": "dns#managedZone",

949

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

950

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

951

# private zones are visible only to Virtual Private Cloud resources.

952

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

953

# that the zone is visible from.

954

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

955

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

956

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

957

# This should be formatted like

958

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

959

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

960

},

961

],

962

"kind": "dns#managedZonePrivateVisibilityConfig",

963

},

964

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

965

# NameServerSet is a set of DNS name servers that all host the same

966

# ManagedZones. Most users will leave this field unset.

967

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

968

# for this zone. The value of this field contains the set of destinations

969

# to forward to.

970

"kind": "dns#managedZoneForwardingConfig",

971

"targetNameServers": [ # List of target name servers to forward to.

972

# Cloud DNS will select the best available name server if more than one

973

# target is given.

974

{

975

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

976

"ipv4Address": "A String", # IPv4 address of a target name server.

977

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

978

# Cloud DNS will make forwarding decision based on address ranges,

979

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

980

# Internet. When set to PRIVATE, Cloud DNS will always send queries

981

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

982

},

983

],

984

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

985

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

986

# server (output only)

987

"A String",

988

],

989

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

990

# lookup zone and Cloud DNS will resolve reverse lookup queries using

991

# automatically configured records for VPC resources. This only applies

992

# to networks listed under private_visibility_config.

993

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

994

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

995

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

996

# for the user's convenience. Has no effect on the managed zone's function.

997

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

998

},

999

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1000

"id": "A String", # Unique identifier for the resource. This is the client_operation_id if

1001

# the client specified it when the mutation was initiated, otherwise,

1002

# it is generated by the server. The name must be 1-63 characters long

1003

# and match the regular expression [-a-z0-9]? (output only)

1004

"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339

1005

# text format (output only).

1006

"user": "A String", # User who requested the operation, for example: user@example.com.

1007

# cloud-dns-system for operations automatically done by the system.

1008

# (output only)

1009

"kind": "dns#operation",

1010

"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE"

1011

# (output only). A status of "DONE" means that the

1012

# request to update the authoritative servers has been sent, but the

1013

# servers might not be updated yet.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1018

<code class="details" id="update">update(project, managedZone, body=None, clientOperationId=None, x__xgafv=None)</code>

1019

<pre>Update an existing ManagedZone.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1020

1021

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1022

project: string, Identifies the project addressed by this request. (required)

1023

managedZone: string, Identifies the managed zone addressed by this request. Can be the managed

1024

zone name or id. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1025

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1026

The object takes the form of:

1027

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1028

{ # A zone is a subtree of the DNS namespace under one administrative

1029

# responsibility. A ManagedZone is a resource that represents a DNS zone

1030

# hosted by the Cloud DNS service.

1031

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

1032

# text format. Output only.

1033

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

1034

# zone. The value of this field contains the network to peer with.

1035

"kind": "dns#managedZonePeeringConfig",

1036

"targetNetwork": { # The network with which to peer.

1037

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

1038

# format. An empty string indicates that the peering connection is

1039

# active. The producer network can deactivate a zone. The zone is

1040

# automatically deactivated if the producer network that the zone

1041

# targeted is deleted. Output only.

1042

"kind": "dns#managedZonePeeringConfigTargetNetwork",

1043

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

1044

# This should be formatted like

1045

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1046

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1047

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1048

"dnssecConfig": { # DNSSEC configuration.

1049

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

1050

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

1051

# Can only be changed while the state is OFF.

1052

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

1053

# ManagedZone. Can only be changed while the state is OFF.

1054

{ # Parameters for DnsKey key generation. Used for generating initial keys

1055

# for a new ManagedZone and as default when adding a new DnsKey.

1056

"keyLength": 42, # Length of the keys in bits.

1057

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

1058

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

1059

# active, will only be used to sign resource record sets of type DNSKEY.

1060

# Zone signing keys do not have the Secure Entry Point flag set and will be

1061

# used to sign all other types of resource record sets.

1062

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

1063

"kind": "dns#dnsKeySpec",

1064

},

1065

],

1066

"kind": "dns#managedZoneDnsSecConfig",

1067

},

1068

"name": "A String", # User assigned name for this resource. Must be unique within the project.

1069

# The name must be 1-63 characters long, must begin with a letter, end with

1070

# a letter or digit, and only contain lowercase letters, digits or dashes.

1071

"labels": { # User labels.

1072

"a_key": "A String",

1073

},

1074

"kind": "dns#managedZone",

1075

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

1076

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

1077

# private zones are visible only to Virtual Private Cloud resources.

1078

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

1079

# that the zone is visible from.

1080

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1081

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1082

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

1083

# This should be formatted like

1084

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

1085

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

1086

},

1087

],

1088

"kind": "dns#managedZonePrivateVisibilityConfig",

1089

},

1090

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

1091

# NameServerSet is a set of DNS name servers that all host the same

1092

# ManagedZones. Most users will leave this field unset.

1093

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

1094

# for this zone. The value of this field contains the set of destinations

1095

# to forward to.

1096

"kind": "dns#managedZoneForwardingConfig",

1097

"targetNameServers": [ # List of target name servers to forward to.

1098

# Cloud DNS will select the best available name server if more than one

1099

# target is given.

1100

{

1101

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

1102

"ipv4Address": "A String", # IPv4 address of a target name server.

1103

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

1104

# Cloud DNS will make forwarding decision based on address ranges,

1105

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

1106

# Internet. When set to PRIVATE, Cloud DNS will always send queries

1107

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1108

},

1109

],

1110

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1111

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

1112

# server (output only)

1113

"A String",

1114

],

1115

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

1116

# lookup zone and Cloud DNS will resolve reverse lookup queries using

1117

# automatically configured records for VPC resources. This only applies

1118

# to networks listed under private_visibility_config.

1119

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1120

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1121

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

1122

# for the user's convenience. Has no effect on the managed zone's function.

1123

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1124

}

1125

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1126

clientOperationId: string, For mutating operation requests only. An optional identifier

1127

specified by the client. Must be unique for operation resources in the

1128

Operations collection.

1129

x__xgafv: string, V1 error format.

1130

Allowed values

1131

1 - v1 error format

1132

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1133

1134

Returns:

1135

An object of the form:

1136

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1137

{ # An operation represents a successful mutation performed on a Cloud DNS

1138

# resource.

1139

# Operations provide:

1140

# - An audit log of server resource mutations.

1141

# - A way to recover/retry API calls in the case where the response is never

1142

# received by the caller. Use the caller specified client_operation_id.

1143

"type": "A String", # Type of the operation. Operations include insert, update, and delete

1144

# (output only).

1145

"dnsKeyContext": { # Only populated if the operation targeted a DnsKey (output only).

1146

"newValue": { # A DNSSEC key pair. # The post-operation DnsKey resource.

1147

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

1148

# for the user's convenience. Has no effect on the resource's function.

1149

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

1150

# DnsKey. These digests are needed to construct a DS record that points at

1151

# this DNS key. Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1152

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1153

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS

1154

# resource record.

1155

"type": "A String", # Specifies the algorithm used to calculate this digest.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1156

},

1157

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1158

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

1159

# Secure Entry Point flag set and, when active, will be used to sign only

1160

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

1161

# flag will be cleared and this key will be used to sign only resource

1162

# record sets of other types. Immutable after creation time.

1163

"creationTime": "A String", # The time that this resource was created in the control plane. This is in

1164

# RFC3339 text format. Output only.

1165

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

1166

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

1167

# Inactive keys will still be present as DNSKEY Resource Records for the use

1168

# of resolvers validating existing signatures.

1169

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

1170

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

1171

# more quickly (but it is not a unique identifier). In particular, the key

1172

# tag is used in a parent zone's DS record to point at the DNSKEY in this

1173

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

1174

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

1175

"kind": "dns#dnsKey",

1176

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

1177

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

1178

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable

1179

# after creation time.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1180

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1181

"oldValue": { # A DNSSEC key pair. # The pre-operation DnsKey resource.

1182

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

1183

# for the user's convenience. Has no effect on the resource's function.

1184

"digests": [ # Cryptographic hashes of the DNSKEY resource record associated with this

1185

# DnsKey. These digests are needed to construct a DS record that points at

1186

# this DNS key. Output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1187

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1188

"digest": "A String", # The base-16 encoded bytes of this digest. Suitable for use in a DS

1189

# resource record.

1190

"type": "A String", # Specifies the algorithm used to calculate this digest.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1191

},

1192

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1193

"type": "A String", # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the

1194

# Secure Entry Point flag set and, when active, will be used to sign only

1195

# resource record sets of type DNSKEY. Otherwise, the Secure Entry Point

1196

# flag will be cleared and this key will be used to sign only resource

1197

# record sets of other types. Immutable after creation time.

1198

"creationTime": "A String", # The time that this resource was created in the control plane. This is in

1199

# RFC3339 text format. Output only.

1200

"publicKey": "A String", # Base64 encoded public half of this key. Output only.

1201

"isActive": True or False, # Active keys will be used to sign subsequent changes to the ManagedZone.

1202

# Inactive keys will still be present as DNSKEY Resource Records for the use

1203

# of resolvers validating existing signatures.

1204

"keyTag": 42, # The key tag is a non-cryptographic hash of the a DNSKEY resource record

1205

# associated with this DnsKey. The key tag can be used to identify a DNSKEY

1206

# more quickly (but it is not a unique identifier). In particular, the key

1207

# tag is used in a parent zone's DS record to point at the DNSKEY in this

1208

# child ManagedZone. The key tag is a number in the range [0, 65535] and the

1209

# algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

1210

"kind": "dns#dnsKey",

1211

"keyLength": 42, # Length of the key in bits. Specified at creation time then immutable.

1212

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

1213

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key. Immutable

1214

# after creation time.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1215

},

1216

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1217

"zoneContext": { # Only populated if the operation targeted a ManagedZone (output only).

1218

"newValue": { # A zone is a subtree of the DNS namespace under one administrative # The post-operation ManagedZone resource.

1219

# responsibility. A ManagedZone is a resource that represents a DNS zone

1220

# hosted by the Cloud DNS service.

1221

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

1222

# text format. Output only.

1223

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

1224

# zone. The value of this field contains the network to peer with.

1225

"kind": "dns#managedZonePeeringConfig",

1226

"targetNetwork": { # The network with which to peer.

1227

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

1228

# format. An empty string indicates that the peering connection is

1229

# active. The producer network can deactivate a zone. The zone is

1230

# automatically deactivated if the producer network that the zone

1231

# targeted is deleted. Output only.

1232

"kind": "dns#managedZonePeeringConfigTargetNetwork",

1233

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

1234

# This should be formatted like

1235

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1236

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1237

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1238

"dnssecConfig": { # DNSSEC configuration.

1239

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

1240

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

1241

# Can only be changed while the state is OFF.

1242

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

1243

# ManagedZone. Can only be changed while the state is OFF.

1244

{ # Parameters for DnsKey key generation. Used for generating initial keys

1245

# for a new ManagedZone and as default when adding a new DnsKey.

1246

"keyLength": 42, # Length of the keys in bits.

1247

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

1248

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

1249

# active, will only be used to sign resource record sets of type DNSKEY.

1250

# Zone signing keys do not have the Secure Entry Point flag set and will be

1251

# used to sign all other types of resource record sets.

1252

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

1253

"kind": "dns#dnsKeySpec",

1254

},

1255

],

1256

"kind": "dns#managedZoneDnsSecConfig",

1257

},

1258

"name": "A String", # User assigned name for this resource. Must be unique within the project.

1259

# The name must be 1-63 characters long, must begin with a letter, end with

1260

# a letter or digit, and only contain lowercase letters, digits or dashes.

1261

"labels": { # User labels.

1262

"a_key": "A String",

1263

},

1264

"kind": "dns#managedZone",

1265

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

1266

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

1267

# private zones are visible only to Virtual Private Cloud resources.

1268

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

1269

# that the zone is visible from.

1270

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1271

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1272

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

1273

# This should be formatted like

1274

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

1275

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

1276

},

1277

],

1278

"kind": "dns#managedZonePrivateVisibilityConfig",

1279

},

1280

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

1281

# NameServerSet is a set of DNS name servers that all host the same

1282

# ManagedZones. Most users will leave this field unset.

1283

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

1284

# for this zone. The value of this field contains the set of destinations

1285

# to forward to.

1286

"kind": "dns#managedZoneForwardingConfig",

1287

"targetNameServers": [ # List of target name servers to forward to.

1288

# Cloud DNS will select the best available name server if more than one

1289

# target is given.

1290

{

1291

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

1292

"ipv4Address": "A String", # IPv4 address of a target name server.

1293

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

1294

# Cloud DNS will make forwarding decision based on address ranges,

1295

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

1296

# Internet. When set to PRIVATE, Cloud DNS will always send queries

1297

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1298

},

1299

],

1300

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1301

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

1302

# server (output only)

1303

"A String",

1304

],

1305

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

1306

# lookup zone and Cloud DNS will resolve reverse lookup queries using

1307

# automatically configured records for VPC resources. This only applies

1308

# to networks listed under private_visibility_config.

1309

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1310

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1311

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

1312

# for the user's convenience. Has no effect on the managed zone's function.

1313

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1314

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1315

"oldValue": { # A zone is a subtree of the DNS namespace under one administrative # The pre-operation ManagedZone resource.

1316

# responsibility. A ManagedZone is a resource that represents a DNS zone

1317

# hosted by the Cloud DNS service.

1318

"creationTime": "A String", # The time that this resource was created on the server. This is in RFC3339

1319

# text format. Output only.

1320

"peeringConfig": { # The presence of this field indicates that DNS Peering is enabled for this

1321

# zone. The value of this field contains the network to peer with.

1322

"kind": "dns#managedZonePeeringConfig",

1323

"targetNetwork": { # The network with which to peer.

1324

"deactivateTime": "A String", # The time at which the zone was deactivated, in RFC 3339 date-time

1325

# format. An empty string indicates that the peering connection is

1326

# active. The producer network can deactivate a zone. The zone is

1327

# automatically deactivated if the producer network that the zone

1328

# targeted is deleted. Output only.

1329

"kind": "dns#managedZonePeeringConfigTargetNetwork",

1330

"networkUrl": "A String", # The fully qualified URL of the VPC network to forward queries to.

1331

# This should be formatted like

1332

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1333

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1334

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1335

"dnssecConfig": { # DNSSEC configuration.

1336

"state": "A String", # Specifies whether DNSSEC is enabled, and what mode it is in.

1337

"nonExistence": "A String", # Specifies the mechanism for authenticated denial-of-existence responses.

1338

# Can only be changed while the state is OFF.

1339

"defaultKeySpecs": [ # Specifies parameters for generating initial DnsKeys for this

1340

# ManagedZone. Can only be changed while the state is OFF.

1341

{ # Parameters for DnsKey key generation. Used for generating initial keys

1342

# for a new ManagedZone and as default when adding a new DnsKey.

1343

"keyLength": 42, # Length of the keys in bits.

1344

"keyType": "A String", # Specifies whether this is a key signing key (KSK) or a zone signing key

1345

# (ZSK). Key signing keys have the Secure Entry Point flag set and, when

1346

# active, will only be used to sign resource record sets of type DNSKEY.

1347

# Zone signing keys do not have the Secure Entry Point flag set and will be

1348

# used to sign all other types of resource record sets.

1349

"algorithm": "A String", # String mnemonic specifying the DNSSEC algorithm of this key.

1350

"kind": "dns#dnsKeySpec",

1351

},

1352

],

1353

"kind": "dns#managedZoneDnsSecConfig",

1354

},

1355

"name": "A String", # User assigned name for this resource. Must be unique within the project.

1356

# The name must be 1-63 characters long, must begin with a letter, end with

1357

# a letter or digit, and only contain lowercase letters, digits or dashes.

1358

"labels": { # User labels.

1359

"a_key": "A String",

1360

},

1361

"kind": "dns#managedZone",

1362

"dnsName": "A String", # The DNS name of this managed zone, for instance "example.com.".

1363

"visibility": "A String", # The zone's visibility: public zones are exposed to the Internet, while

1364

# private zones are visible only to Virtual Private Cloud resources.

1365

"privateVisibilityConfig": { # For privately visible zones, the set of Virtual Private Cloud resources

1366

# that the zone is visible from.

1367

"networks": [ # The list of VPC networks that can see this zone.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1368

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1369

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

1370

# This should be formatted like

1371

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

1372

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

1373

},

1374

],

1375

"kind": "dns#managedZonePrivateVisibilityConfig",

1376

},

1377

"nameServerSet": "A String", # Optionally specifies the NameServerSet for this ManagedZone. A

1378

# NameServerSet is a set of DNS name servers that all host the same

1379

# ManagedZones. Most users will leave this field unset.

1380

"forwardingConfig": { # The presence for this field indicates that outbound forwarding is enabled

1381

# for this zone. The value of this field contains the set of destinations

1382

# to forward to.

1383

"kind": "dns#managedZoneForwardingConfig",

1384

"targetNameServers": [ # List of target name servers to forward to.

1385

# Cloud DNS will select the best available name server if more than one

1386

# target is given.

1387

{

1388

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

1389

"ipv4Address": "A String", # IPv4 address of a target name server.

1390

"forwardingPath": "A String", # Forwarding path for this NameServerTarget, if unset or set to DEFAULT,

1391

# Cloud DNS will make forwarding decision based on address ranges,

1392

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

1393

# Internet. When set to PRIVATE, Cloud DNS will always send queries

1394

# through VPC for this target

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1395

},

1396

],

1397

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1398

"nameServers": [ # Delegate your managed_zone to these virtual name servers; defined by the

1399

# server (output only)

1400

"A String",

1401

],

1402

"reverseLookupConfig": { # The presence of this field indicates that this is a managed reverse

1403

# lookup zone and Cloud DNS will resolve reverse lookup queries using

1404

# automatically configured records for VPC resources. This only applies

1405

# to networks listed under private_visibility_config.

1406

"kind": "dns#managedZoneReverseLookupConfig",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1407

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1408

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

1409

# for the user's convenience. Has no effect on the managed zone's function.

1410

"id": "A String", # Unique identifier for the resource; defined by the server (output only)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1411

},

1412

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1413

"id": "A String", # Unique identifier for the resource. This is the client_operation_id if

1414

# the client specified it when the mutation was initiated, otherwise,

1415

# it is generated by the server. The name must be 1-63 characters long

1416

# and match the regular expression [-a-z0-9]? (output only)

1417

"startTime": "A String", # The time that this operation was started by the server. This is in RFC3339

1418

# text format (output only).

1419

"user": "A String", # User who requested the operation, for example: user@example.com.

1420

# cloud-dns-system for operations automatically done by the system.

1421

# (output only)

1422

"kind": "dns#operation",

1423

"status": "A String", # Status of the operation. Can be one of the following: "PENDING" or "DONE"

1424

# (output only). A status of "DONE" means that the

1425

# request to update the authoritative servers has been sent, but the

1426

# servers might not be updated yet.

Bu Sun Kim