Get
|
|||||
|
|
||||
Fetch the representation of an existing DnsKey
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View your data across Google Cloud Platform services
- View your DNS records hosted by Google Cloud DNS
- View and manage your DNS records hosted by Google Cloud DNS
Input
This building block consumes 5 input parameters
| Name | Format | Description |
|---|---|---|
project Required |
STRING |
Identifies the project addressed by this request |
managedZone Required |
STRING |
Identifies the managed zone addressed by this request. Can be the managed zone name or id |
dnsKeyId Required |
STRING |
The identifier of the requested DnsKey |
clientOperationId |
STRING |
For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection |
digestType |
STRING |
An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed |
= Parameter name
= Format
|
project STRING Required Identifies the project addressed by this request |
|
managedZone STRING Required Identifies the managed zone addressed by this request. Can be the managed zone name or id |
|
dnsKeyId STRING Required The identifier of the requested DnsKey |
|
clientOperationId STRING For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection |
|
digestType STRING An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
algorithm |
ENUMERATION |
String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time |
creationTime |
STRING |
The time that this resource was created in the control plane. This is in RFC3339 text format. Output only |
description |
STRING |
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function |
digests[] |
OBJECT |
|
digests[].digest |
STRING |
The base-16 encoded bytes of this digest. Suitable for use in a DS resource record |
digests[].type |
ENUMERATION |
Specifies the algorithm used to calculate this digest |
id |
STRING |
Unique identifier for the resource; defined by the server (output only) |
isActive |
BOOLEAN |
Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures |
keyLength |
INTEGER |
Length of the key in bits. Specified at creation time then immutable |
keyTag |
INTEGER |
The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey" |
publicKey |
STRING |
Base64 encoded public half of this key. Output only |
type |
ENUMERATION |
One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time |
= Parameter name
= Format
|
algorithm ENUMERATION String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time |
|
creationTime STRING The time that this resource was created in the control plane. This is in RFC3339 text format. Output only |
|
description STRING A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function |
|
digests[] OBJECT |
|
digests[].digest STRING The base-16 encoded bytes of this digest. Suitable for use in a DS resource record |
|
digests[].type ENUMERATION Specifies the algorithm used to calculate this digest |
|
id STRING Unique identifier for the resource; defined by the server (output only) |
|
isActive BOOLEAN Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures |
|
keyLength INTEGER Length of the key in bits. Specified at creation time then immutable |
|
keyTag INTEGER The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey" |
|
publicKey STRING Base64 encoded public half of this key. Output only |
|
type ENUMERATION One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time |