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

2016-10-21 13:59:49 -0700

[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_v2beta1.html">Cloud DNS API</a> . <a href="dns_v2beta1.managedZones.html">managedZones</a></h1>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

86

Bu Sun Kim

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

[diff] [blame]

87

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

88

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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>

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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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

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

112

# server (output only)

Bu Sun Kim

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

[diff] [blame]

113

"A String",

114

],

Bu Sun Kim

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

[diff] [blame]

115

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

116

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

117

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

118

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

119

# ManagedZones. Most users will leave this field unset.

120

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

121

# that the zone is visible from.

122

"kind": "dns#managedZonePrivateVisibilityConfig",

123

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

Bu Sun Kim

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

[diff] [blame]

124

{

Bu Sun Kim

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

[diff] [blame]

125

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

126

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

127

# This should be formatted like

128

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

Bu Sun Kim

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

[diff] [blame]

129

},

130

],

131

},

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

134

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

135

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

136

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

137

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

138

# text format. Output only.

139

"labels": { # User labels.

140

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

141

},

Bu Sun Kim

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

[diff] [blame]

142

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

143

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

144

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

145

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

146

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

147

# This should be formatted like

148

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

149

"kind": "dns#managedZonePeeringConfigTargetNetwork",

150

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

151

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

152

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

153

# automatically deactivated if the producer network that the zone

154

# targeted is deleted. Output only.

155

},

156

"kind": "dns#managedZonePeeringConfig",

157

},

158

"dnssecConfig": { # DNSSEC configuration.

159

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

160

# Can only be changed while the state is OFF.

161

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

162

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

163

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

164

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

165

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

166

"kind": "dns#dnsKeySpec",

167

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

168

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

169

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

170

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

171

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

172

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

173

},

174

],

175

"kind": "dns#managedZoneDnsSecConfig",

176

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

177

},

178

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

179

"kind": "dns#managedZone",

180

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

181

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

182

# automatically configured records for VPC resources. This only applies

183

# to networks listed under private_visibility_config.

184

"kind": "dns#managedZoneReverseLookupConfig",

185

},

186

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

187

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

188

# to forward to.

189

"kind": "dns#managedZoneForwardingConfig",

190

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

191

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

192

# target is given.

193

{

194

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

195

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

196

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

197

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

198

# through VPC for this target

199

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

200

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

201

},

202

],

203

},

Sai Cheemalapati

2016-10-21 13:59:49 -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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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

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

221

# server (output only)

Bu Sun Kim

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

[diff] [blame]

222

"A String",

223

],

Bu Sun Kim

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

[diff] [blame]

224

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

225

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

226

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

227

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

228

# ManagedZones. Most users will leave this field unset.

229

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

230

# that the zone is visible from.

231

"kind": "dns#managedZonePrivateVisibilityConfig",

232

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

Bu Sun Kim

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

[diff] [blame]

233

{

Bu Sun Kim

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

[diff] [blame]

234

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

235

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

236

# This should be formatted like

237

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

Bu Sun Kim

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

[diff] [blame]

238

},

239

],

240

},

Bu Sun Kim

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

[diff] [blame]

241

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

242

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

243

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

244

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

245

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

246

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

247

# text format. Output only.

248

"labels": { # User labels.

249

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

250

},

Bu Sun Kim

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

[diff] [blame]

251

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

252

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

253

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

254

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

255

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

256

# This should be formatted like

257

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

258

"kind": "dns#managedZonePeeringConfigTargetNetwork",

259

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

260

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

261

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

262

# automatically deactivated if the producer network that the zone

263

# targeted is deleted. Output only.

264

},

265

"kind": "dns#managedZonePeeringConfig",

266

},

267

"dnssecConfig": { # DNSSEC configuration.

268

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

269

# Can only be changed while the state is OFF.

270

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

271

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

272

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

273

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

274

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

275

"kind": "dns#dnsKeySpec",

276

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

277

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

278

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

279

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

280

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

281

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

282

},

283

],

284

"kind": "dns#managedZoneDnsSecConfig",

285

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

286

},

287

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

288

"kind": "dns#managedZone",

289

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

290

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

291

# automatically configured records for VPC resources. This only applies

292

# to networks listed under private_visibility_config.

293

"kind": "dns#managedZoneReverseLookupConfig",

294

},

295

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

296

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

297

# to forward to.

298

"kind": "dns#managedZoneForwardingConfig",

299

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

300

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

301

# target is given.

302

{

303

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

304

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

305

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

306

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

307

# through VPC for this target

308

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

309

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

310

},

311

],

312

},

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

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

357

# server (output only)

Bu Sun Kim

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

[diff] [blame]

358

"A String",

359

],

Bu Sun Kim

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

[diff] [blame]

360

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

361

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

362

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

363

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

364

# ManagedZones. Most users will leave this field unset.

365

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

366

# that the zone is visible from.

367

"kind": "dns#managedZonePrivateVisibilityConfig",

368

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

Bu Sun Kim

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

[diff] [blame]

369

{

Bu Sun Kim

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

[diff] [blame]

370

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

371

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

372

# This should be formatted like

373

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

Bu Sun Kim

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

[diff] [blame]

374

},

375

],

376

},

Bu Sun Kim

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

[diff] [blame]

377

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

378

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

379

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

380

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

381

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

382

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

383

# text format. Output only.

384

"labels": { # User labels.

385

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

386

},

Bu Sun Kim

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

[diff] [blame]

387

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

388

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

389

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

390

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

391

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

392

# This should be formatted like

393

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

394

"kind": "dns#managedZonePeeringConfigTargetNetwork",

395

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

396

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

397

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

398

# automatically deactivated if the producer network that the zone

399

# targeted is deleted. Output only.

400

},

401

"kind": "dns#managedZonePeeringConfig",

402

},

403

"dnssecConfig": { # DNSSEC configuration.

404

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

405

# Can only be changed while the state is OFF.

406

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

407

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

408

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

409

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

410

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

411

"kind": "dns#dnsKeySpec",

412

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

413

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

414

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

415

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

416

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

417

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

418

},

419

],

420

"kind": "dns#managedZoneDnsSecConfig",

421

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

422

},

423

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

424

"kind": "dns#managedZone",

425

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

426

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

427

# automatically configured records for VPC resources. This only applies

428

# to networks listed under private_visibility_config.

429

"kind": "dns#managedZoneReverseLookupConfig",

430

},

431

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

432

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

433

# to forward to.

434

"kind": "dns#managedZoneForwardingConfig",

435

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

436

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

437

# target is given.

438

{

439

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

440

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

441

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

442

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

443

# through VPC for this target

444

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

445

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

446

},

447

],

448

},

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, maxResults=None, pageToken=None, dnsName=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

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

459

server will decide how many results to return.

460

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

461

Use this parameter to continue a previous list request.

462

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

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-05-20 12:08:20 -0700

[diff] [blame]

472

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

Bu Sun Kim

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

[diff] [blame]

473

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

474

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

475

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

476

#

477

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

478

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

479

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

480

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

481

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

482

# maximum page size.

483

"managedZones": [ # The managed zone resources.

484

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

485

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

486

# hosted by the Cloud DNS service.

487

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

488

# server (output only)

Bu Sun Kim

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

[diff] [blame]

489

"A String",

490

],

Bu Sun Kim

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

[diff] [blame]

491

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

492

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

493

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

494

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

495

# ManagedZones. Most users will leave this field unset.

496

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

497

# that the zone is visible from.

498

"kind": "dns#managedZonePrivateVisibilityConfig",

499

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

Bu Sun Kim

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

[diff] [blame]

500

{

Bu Sun Kim

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

[diff] [blame]

501

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

502

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

503

# This should be formatted like

504

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

Bu Sun Kim

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

[diff] [blame]

505

},

506

],

507

},

Bu Sun Kim

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

[diff] [blame]

508

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

509

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

510

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

511

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

512

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

513

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

514

# text format. Output only.

515

"labels": { # User labels.

516

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

517

},

Bu Sun Kim

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

[diff] [blame]

518

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

519

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

520

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

521

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

522

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

523

# This should be formatted like

524

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

525

"kind": "dns#managedZonePeeringConfigTargetNetwork",

526

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

527

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

528

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

529

# automatically deactivated if the producer network that the zone

530

# targeted is deleted. Output only.

531

},

532

"kind": "dns#managedZonePeeringConfig",

533

},

534

"dnssecConfig": { # DNSSEC configuration.

535

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

536

# Can only be changed while the state is OFF.

537

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

538

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

539

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

540

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

541

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

542

"kind": "dns#dnsKeySpec",

543

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

544

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

545

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

546

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

547

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

548

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

549

},

550

],

551

"kind": "dns#managedZoneDnsSecConfig",

552

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

553

},

554

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

555

"kind": "dns#managedZone",

556

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

557

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

558

# automatically configured records for VPC resources. This only applies

559

# to networks listed under private_visibility_config.

560

"kind": "dns#managedZoneReverseLookupConfig",

561

},

562

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

563

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

564

# to forward to.

565

"kind": "dns#managedZoneForwardingConfig",

566

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

567

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

568

# target is given.

569

{

570

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

571

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

572

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

573

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

574

# through VPC for this target

575

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

576

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

577

},

578

],

579

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

580

},

581

],

Bu Sun Kim

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

[diff] [blame]

582

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

583

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

584

# This is the client_operation_id if the client specified it,

585

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

586

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

600

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

</pre>

</div>

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.

Sai Cheemalapati

2016-10-21 13:59:49 -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.

Sai Cheemalapati

2016-10-21 13:59:49 -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

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

619

# server (output only)

Bu Sun Kim

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

[diff] [blame]

620

"A String",

621

],

Bu Sun Kim

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

[diff] [blame]

622

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

623

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

624

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

625

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

626

# ManagedZones. Most users will leave this field unset.

627

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

628

# that the zone is visible from.

629

"kind": "dns#managedZonePrivateVisibilityConfig",

630

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

Bu Sun Kim

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

[diff] [blame]

631

{

Bu Sun Kim

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

[diff] [blame]

632

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

633

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

634

# This should be formatted like

635

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

Bu Sun Kim

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

[diff] [blame]

636

},

637

],

638

},

Bu Sun Kim

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

[diff] [blame]

639

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

640

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

641

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

642

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

643

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

644

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

645

# text format. Output only.

646

"labels": { # User labels.

647

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

648

},

Bu Sun Kim

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

[diff] [blame]

649

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

650

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

651

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

652

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

653

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

654

# This should be formatted like

655

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

656

"kind": "dns#managedZonePeeringConfigTargetNetwork",

657

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

658

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

659

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

660

# automatically deactivated if the producer network that the zone

661

# targeted is deleted. Output only.

662

},

663

"kind": "dns#managedZonePeeringConfig",

664

},

665

"dnssecConfig": { # DNSSEC configuration.

666

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

667

# Can only be changed while the state is OFF.

668

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

669

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

670

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

671

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

672

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

673

"kind": "dns#dnsKeySpec",

674

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

675

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

676

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

677

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

678

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

679

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

680

},

681

],

682

"kind": "dns#managedZoneDnsSecConfig",

683

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

684

},

685

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

686

"kind": "dns#managedZone",

687

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

688

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

689

# automatically configured records for VPC resources. This only applies

690

# to networks listed under private_visibility_config.

691

"kind": "dns#managedZoneReverseLookupConfig",

692

},

693

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

694

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

695

# to forward to.

696

"kind": "dns#managedZoneForwardingConfig",

697

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

698

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

699

# target is given.

700

{

701

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

702

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

703

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

704

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

705

# through VPC for this target

706

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

707

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

708

},

709

],

710

},

Sai Cheemalapati

2016-10-21 13:59:49 -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

Sai Cheemalapati

2016-10-21 13:59:49 -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

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

731

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

732

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

733

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

734

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

735

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

736

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

737

# hosted by the Cloud DNS service.

738

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

739

# server (output only)

740

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

741

],

Bu Sun Kim

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

[diff] [blame]

742

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

743

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

744

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

745

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

746

# ManagedZones. Most users will leave this field unset.

747

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

748

# that the zone is visible from.

749

"kind": "dns#managedZonePrivateVisibilityConfig",

750

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

751

{

752

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

753

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

754

# This should be formatted like

755

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

},

],

},

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

760

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

761

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

762

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

763

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

764

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

765

# text format. Output only.

766

"labels": { # User labels.

767

"a_key": "A String",

768

},

769

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

770

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

771

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

772

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

773

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

774

# This should be formatted like

775

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

776

"kind": "dns#managedZonePeeringConfigTargetNetwork",

777

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

778

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

779

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

780

# automatically deactivated if the producer network that the zone

781

# targeted is deleted. Output only.

782

},

783

"kind": "dns#managedZonePeeringConfig",

784

},

785

"dnssecConfig": { # DNSSEC configuration.

786

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

787

# Can only be changed while the state is OFF.

788

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

789

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

790

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

791

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

792

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

793

"kind": "dns#dnsKeySpec",

794

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

795

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

796

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

797

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

798

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

799

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

800

},

801

],

802

"kind": "dns#managedZoneDnsSecConfig",

803

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

804

},

805

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

806

"kind": "dns#managedZone",

807

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

808

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

809

# automatically configured records for VPC resources. This only applies

810

# to networks listed under private_visibility_config.

811

"kind": "dns#managedZoneReverseLookupConfig",

812

},

813

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

814

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

815

# to forward to.

816

"kind": "dns#managedZoneForwardingConfig",

817

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

818

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

819

# target is given.

820

{

821

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

822

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

823

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

824

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

825

# through VPC for this target

826

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

827

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

828

},

829

],

830

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

831

},

Bu Sun Kim

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

[diff] [blame]

832

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

833

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

834

# hosted by the Cloud DNS service.

835

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

836

# server (output only)

837

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

838

],

Bu Sun Kim

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

[diff] [blame]

839

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

840

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

841

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

842

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

843

# ManagedZones. Most users will leave this field unset.

844

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

845

# that the zone is visible from.

846

"kind": "dns#managedZonePrivateVisibilityConfig",

847

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

848

{

849

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

850

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

851

# This should be formatted like

852

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

},

],

},

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

857

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

858

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

859

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

860

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

861

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

862

# text format. Output only.

863

"labels": { # User labels.

864

"a_key": "A String",

865

},

866

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

867

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

868

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

869

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

870

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

871

# This should be formatted like

872

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

873

"kind": "dns#managedZonePeeringConfigTargetNetwork",

874

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

875

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

876

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

877

# automatically deactivated if the producer network that the zone

878

# targeted is deleted. Output only.

879

},

880

"kind": "dns#managedZonePeeringConfig",

881

},

882

"dnssecConfig": { # DNSSEC configuration.

883

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

884

# Can only be changed while the state is OFF.

885

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

886

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

887

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

888

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

889

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

890

"kind": "dns#dnsKeySpec",

891

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

892

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

893

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

894

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

895

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

896

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

897

},

898

],

899

"kind": "dns#managedZoneDnsSecConfig",

900

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

901

},

902

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

903

"kind": "dns#managedZone",

904

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

905

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

906

# automatically configured records for VPC resources. This only applies

907

# to networks listed under private_visibility_config.

908

"kind": "dns#managedZoneReverseLookupConfig",

909

},

910

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

911

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

912

# to forward to.

913

"kind": "dns#managedZoneForwardingConfig",

914

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

915

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

916

# target is given.

917

{

918

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

919

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

920

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

921

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

922

# through VPC for this target

923

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

924

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

925

},

926

],

927

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

928

},

929

},

Bu Sun Kim

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

[diff] [blame]

930

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

931

# (output only).

932

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

933

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

934

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

935

# servers might not be updated yet.

936

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

937

# text format (output only).

938

"kind": "dns#operation",

939

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

940

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

941

# (output only)

942

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

943

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

944

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

945

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

946

# of resolvers validating existing signatures.

947

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

948

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

949

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

950

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

951

# RFC3339 text format. Output only.

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

"kind": "dns#dnsKey",

964

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

965

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

966

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

967

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

968

# this DNS key. Output only.

969

{

970

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

971

# resource record.

972

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

Dan O'Meara

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

[diff] [blame]

973

},

Bu Sun Kim

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

[diff] [blame]

974

],

975

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

976

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

977

},

Bu Sun Kim

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

[diff] [blame]

978

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

979

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

980

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

981

# of resolvers validating existing signatures.

982

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

983

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

984

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

985

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

986

# RFC3339 text format. Output only.

987

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

988

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

989

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

990

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

991

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

992

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

993

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

994

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

995

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

996

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

997

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

998

"kind": "dns#dnsKey",

999

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

1000

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

1001

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

1002

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

1003

# this DNS key. Output only.

1004

{

1005

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

1006

# resource record.

1007

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

Dan O'Meara

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

[diff] [blame]

1008

},

Bu Sun Kim

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

[diff] [blame]

1009

],

1010

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

1011

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1012

},

1013

},

Sai Cheemalapati

2016-10-21 13:59:49 -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.

Sai Cheemalapati

2016-10-21 13:59:49 -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.

Sai Cheemalapati

2016-10-21 13:59:49 -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

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

1032

# server (output only)

Bu Sun Kim

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

[diff] [blame]

1033

"A String",

1034

],

Bu Sun Kim

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

[diff] [blame]

1035

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

1036

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

1037

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

1038

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

1039

# ManagedZones. Most users will leave this field unset.

1040

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

1041

# that the zone is visible from.

1042

"kind": "dns#managedZonePrivateVisibilityConfig",

1043

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

Bu Sun Kim

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

[diff] [blame]

1044

{

Bu Sun Kim

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

[diff] [blame]

1045

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

1046

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

1047

# This should be formatted like

1048

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

Bu Sun Kim

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

[diff] [blame]

1049

},

1050

],

1051

},

Bu Sun Kim

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

[diff] [blame]

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

# text format. Output only.

1059

"labels": { # User labels.

1060

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1061

},

Bu Sun Kim

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

[diff] [blame]

1062

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

1063

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

1064

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

1065

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

1066

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

1067

# This should be formatted like

1068

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

1069

"kind": "dns#managedZonePeeringConfigTargetNetwork",

1070

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

1071

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

1072

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

1073

# automatically deactivated if the producer network that the zone

1074

# targeted is deleted. Output only.

1075

},

1076

"kind": "dns#managedZonePeeringConfig",

1077

},

1078

"dnssecConfig": { # DNSSEC configuration.

1079

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

1080

# Can only be changed while the state is OFF.

1081

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

1082

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

1083

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

1084

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

1085

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

1086

"kind": "dns#dnsKeySpec",

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

},

1094

],

1095

"kind": "dns#managedZoneDnsSecConfig",

1096

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

1097

},

1098

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

1099

"kind": "dns#managedZone",

1100

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

1101

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

1102

# automatically configured records for VPC resources. This only applies

1103

# to networks listed under private_visibility_config.

1104

"kind": "dns#managedZoneReverseLookupConfig",

1105

},

1106

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

1107

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

1108

# to forward to.

1109

"kind": "dns#managedZoneForwardingConfig",

1110

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

1111

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

1112

# target is given.

1113

{

1114

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

1115

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

1116

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

1117

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

1118

# through VPC for this target

1119

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

1120

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

1121

},

1122

],

1123

},

Sai Cheemalapati

2016-10-21 13:59:49 -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

Sai Cheemalapati

2016-10-21 13:59:49 -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

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

# hosted by the Cloud DNS service.

1151

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

1152

# server (output only)

1153

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1154

],

Bu Sun Kim

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

[diff] [blame]

1155

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

1156

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

1157

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

1158

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

1159

# ManagedZones. Most users will leave this field unset.

1160

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

1161

# that the zone is visible from.

1162

"kind": "dns#managedZonePrivateVisibilityConfig",

1163

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

1164

{

1165

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

1166

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

1167

# This should be formatted like

1168

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

},

],

},

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

# text format. Output only.

1179

"labels": { # User labels.

1180

"a_key": "A String",

1181

},

1182

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

1183

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

1184

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

1185

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

1186

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

1187

# This should be formatted like

1188

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

1189

"kind": "dns#managedZonePeeringConfigTargetNetwork",

1190

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

1191

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

1192

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

1193

# automatically deactivated if the producer network that the zone

1194

# targeted is deleted. Output only.

1195

},

1196

"kind": "dns#managedZonePeeringConfig",

1197

},

1198

"dnssecConfig": { # DNSSEC configuration.

1199

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

1200

# Can only be changed while the state is OFF.

1201

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

1202

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

1203

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

1204

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

1205

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

1206

"kind": "dns#dnsKeySpec",

1207

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

1208

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

1209

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

1210

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

1211

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

1212

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

1213

},

1214

],

1215

"kind": "dns#managedZoneDnsSecConfig",

1216

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

1217

},

1218

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

1219

"kind": "dns#managedZone",

1220

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

1221

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

1222

# automatically configured records for VPC resources. This only applies

1223

# to networks listed under private_visibility_config.

1224

"kind": "dns#managedZoneReverseLookupConfig",

1225

},

1226

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

1227

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

1228

# to forward to.

1229

"kind": "dns#managedZoneForwardingConfig",

1230

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

1231

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

1232

# target is given.

1233

{

1234

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

1235

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

1236

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

1237

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

1238

# through VPC for this target

1239

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

1240

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

1241

},

1242

],

1243

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1244

},

Bu Sun Kim

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

[diff] [blame]

1245

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

1246

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

1247

# hosted by the Cloud DNS service.

1248

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

1249

# server (output only)

1250

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1251

],

Bu Sun Kim

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

[diff] [blame]

1252

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

1253

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

1254

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

1255

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

1256

# ManagedZones. Most users will leave this field unset.

1257

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

1258

# that the zone is visible from.

1259

"kind": "dns#managedZonePrivateVisibilityConfig",

1260

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

1261

{

1262

"kind": "dns#managedZonePrivateVisibilityConfigNetwork",

1263

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

1264

# This should be formatted like

1265

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

},

],

},

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

1270

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

1271

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

1272

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

1273

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

1274

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

1275

# text format. Output only.

1276

"labels": { # User labels.

1277

"a_key": "A String",

1278

},

1279

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

1280

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

1281

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

1282

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

1283

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

1284

# This should be formatted like

1285

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

1286

"kind": "dns#managedZonePeeringConfigTargetNetwork",

1287

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

1288

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

1289

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

1290

# automatically deactivated if the producer network that the zone

1291

# targeted is deleted. Output only.

1292

},

1293

"kind": "dns#managedZonePeeringConfig",

1294

},

1295

"dnssecConfig": { # DNSSEC configuration.

1296

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

1297

# Can only be changed while the state is OFF.

1298

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

1299

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

1300

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

1301

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

1302

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

1303

"kind": "dns#dnsKeySpec",

1304

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

1305

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

1306

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

1307

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

1308

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

1309

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

1310

},

1311

],

1312

"kind": "dns#managedZoneDnsSecConfig",

1313

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

1314

},

1315

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

1316

"kind": "dns#managedZone",

1317

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

1318

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

1319

# automatically configured records for VPC resources. This only applies

1320

# to networks listed under private_visibility_config.

1321

"kind": "dns#managedZoneReverseLookupConfig",

1322

},

1323

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

1324

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

1325

# to forward to.

1326

"kind": "dns#managedZoneForwardingConfig",

1327

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

1328

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

1329

# target is given.

1330

{

1331

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

1332

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

1333

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

1334

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

1335

# through VPC for this target

1336

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

1337

"kind": "dns#managedZoneForwardingConfigNameServerTarget",

1338

},

1339

],

1340

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1341

},

1342

},

Bu Sun Kim

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

[diff] [blame]

1343

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

1344

# (output only).

1345

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

1346

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

1347

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

1348

# servers might not be updated yet.

1349

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

1350

# text format (output only).

1351

"kind": "dns#operation",

1352

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

1353

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

1354

# (output only)

1355

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

1356

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

1357

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

1358

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

1359

# of resolvers validating existing signatures.

1360

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

1361

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

1362

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

1363

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

1364

# RFC3339 text format. Output only.

1365

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

1366

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

1367

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

1368

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

1369

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

1370

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

1371

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

1372

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

1373

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

1374

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

1375

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

1376

"kind": "dns#dnsKey",

1377

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

1378

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

1379

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

1380

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

1381

# this DNS key. Output only.

1382

{

1383

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

1384

# resource record.

1385

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

Dan O'Meara

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

[diff] [blame]

1386

},

Bu Sun Kim

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

[diff] [blame]

1387

],

1388

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

1389

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1390

},

Bu Sun Kim

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

[diff] [blame]

1391

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

1392

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

1393

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

1394

# of resolvers validating existing signatures.

1395

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

1396

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

1397

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

1398

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

1399

# RFC3339 text format. Output only.

1400

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

1401

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

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

"kind": "dns#dnsKey",

1412

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

1413

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

1414

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

1415

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

1416

# this DNS key. Output only.

1417

{

1418

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

1419

# resource record.

1420

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

Dan O'Meara

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

[diff] [blame]

1421

},

Bu Sun Kim

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

[diff] [blame]

1422

],

1423

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

1424

# after creation time.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1425

},

1426

},

Sai Cheemalapati