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

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -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_v1.html">Cloud DNS API</a> . <a href="dns_v1.dnsKeys.html">dnsKeys</a></h1>

Bu Sun Kim

715bd7f

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

d059ad8

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

[diff] [blame^]

78

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

79

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

80

Bu Sun Kim

d059ad8

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

[diff] [blame^]

81

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

82

<p class="firstline">Enumerate DnsKeys to a ResourceRecordSet collection.</p>

Bu Sun Kim

715bd7f

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

[diff] [blame]

83

84

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

85

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

86

<h3>Method Details</h3>

87

Bu Sun Kim

d059ad8

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

[diff] [blame^]

88

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

89

<pre>Fetch the representation of an existing DnsKey.

Bu Sun Kim

715bd7f

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

[diff] [blame]

90

91

Args:

Bu Sun Kim

d059ad8

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

[diff] [blame^]

92

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

93

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

94

zone name or id. (required)

95

dnsKeyId: string, The identifier of the requested DnsKey. (required)

96

digestType: string, An optional comma-separated list of digest types to compute and display

97

for key signing keys. If omitted, the recommended digest type will be

98

computed and displayed.

99

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

100

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

101

Operations collection.

102

x__xgafv: string, V1 error format.

103

Allowed values

104

1 - v1 error format

105

2 - v2 error format

Bu Sun Kim

715bd7f

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

[diff] [blame]

106

107

Returns:

108

An object of the form:

109

Bu Sun Kim

d059ad8

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

[diff] [blame^]

110

{ # A DNSSEC key pair.

111

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

112

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

113

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

114

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

115

# this DNS key. Output only.

Bu Sun Kim

715bd7f

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

[diff] [blame]

116

{

Bu Sun Kim

d059ad8

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

[diff] [blame^]

117

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

118

# resource record.

119

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

120

},

121

],

Bu Sun Kim

d059ad8

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

[diff] [blame^]

122

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

123

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

124

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

125

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

126

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

127

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

128

# RFC3339 text format. Output only.

129

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

130

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

131

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

132

# of resolvers validating existing signatures.

133

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

134

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

135

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

136

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

137

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

138

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

139

"kind": "dns#dnsKey",

140

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

141

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

142

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

143

# after creation time.

Bu Sun Kim

715bd7f

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

148

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

149

<pre>Enumerate DnsKeys to a ResourceRecordSet collection.

Bu Sun Kim

715bd7f

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

[diff] [blame]

150

151

Args:

Bu Sun Kim

d059ad8

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

[diff] [blame^]

152

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

153

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

154

zone name or id. (required)

155

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

156

Use this parameter to continue a previous list request.

157

digestType: string, An optional comma-separated list of digest types to compute and display

158

for key signing keys. If omitted, the recommended digest type will be

159

computed and displayed.

160

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

161

server will decide how many results to return.

162

x__xgafv: string, V1 error format.

163

Allowed values

164

1 - v1 error format

165

2 - v2 error format

Bu Sun Kim

715bd7f

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

[diff] [blame]

166

167

Returns:

168

An object of the form:

169

Bu Sun Kim

d059ad8

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

[diff] [blame^]

170

{ # The response to a request to enumerate DnsKeys in a ManagedZone.

171

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

172

"dnsKeys": [ # The requested resources.

173

{ # A DNSSEC key pair.

174

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

175

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

176

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

177

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

178

# this DNS key. Output only.

Bu Sun Kim

715bd7f

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

[diff] [blame]

179

{

Bu Sun Kim

d059ad8

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

[diff] [blame^]

180

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

181

# resource record.

182

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

183

},

184

],

Bu Sun Kim

d059ad8

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

[diff] [blame^]

185

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

186

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

187

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

188

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

189

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

190

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

191

# RFC3339 text format. Output only.

192

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

193

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

194

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

195

# of resolvers validating existing signatures.

196

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

197

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

198

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

199

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

200

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

201

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

202

"kind": "dns#dnsKey",

203

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

204

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

205

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

206

# after creation time.

Bu Sun Kim

715bd7f

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

[diff] [blame]

207

},

208

],

Bu Sun Kim

d059ad8

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

[diff] [blame^]

209

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

210

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

211

# This is the client_operation_id if the client specified it,

212

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

Bu Sun Kim

6502091

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

[diff] [blame]

213

},

Bu Sun Kim

d059ad8

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

[diff] [blame^]

214

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

215

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

216

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

217

#

218

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

219

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

220

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

221

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

222

# no way to retrieve a "snapshot" of collections larger than the maximum

223

# page size.

Bu Sun Kim

715bd7f

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

[diff] [blame]

}</pre>

</div>

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

229

<pre>Retrieves the next page of results.

230

231

Args:

232

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

233

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

234

235

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

236

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

237

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

</pre>

</div>

</body></html>