Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1348107211.1 KB
projects

Creates a new AutomatedDnsRecord in a given project and location.

post/v1/{+parent}/automatedDnsRecords

Path parameters

parentstring required

Required. The parent resource's name of the AutomatedDnsRecord. ex. projects/123/locations/us-east1

Query parameters

automatedDnsRecordIdstring

Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/automatedDnsRecords/foo') See https://google.aip.dev/122#resource-id-segments Unique per location. If one is not provided, one will be generated.

insertMode'INSERT_MODE_UNSPECIFIED' | 'FAIL_IF_EXISTS' | 'OVERWRITE'

Optional. The insert mode when creating AutomatedDnsRecord.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

stateDetailsstring

Output only. A human-readable message providing more context about the current state, such as an error description if the state is FAILED_DEPROGRAMMING.

labelsobject

Optional. User-defined labels.

creationMode'CREATION_MODE_UNSPECIFIED' | 'CONSUMER_API' | 'SERVICE_CONNECTION_MAP'

Required. Immutable. The creation mode of the AutomatedDnsRecord. This field is immutable.

recordType'RECORD_TYPE_UNSPECIFIED' | 'A' | 'AAAA' | 'TXT' | 'CNAME'

Required. Immutable. The identifier of a supported record type.

consumerNetworkstring

Required. Immutable. The full resource path of the consumer network this AutomatedDnsRecord is visible to. Example: "projects/{projectNumOrId}/global/networks/{networkName}".

state'STATE_UNSPECIFIED' | 'PROGRAMMED' | 'FAILED_DEPROGRAMMING' | 'CREATING' | 'DELETING'

Output only. The current operational state of this AutomatedDnsRecord as managed by Service Connectivity Automation.

descriptionstring

A human-readable description of the record.

createTimestring google-datetime

Output only. The timestamp of when the record was created.

namestring

Immutable. Identifier. The name of an AutomatedDnsRecord. Format: projects/{project}/locations/{location}/automatedDnsRecords/{automated_dns_record} See: https://google.aip.dev/122#fields-representing-resource-names

dnsZonestring

Output only. DnsZone is the DNS zone managed by automation. Format: projects/{project}/managedZones/{managedZone}

etagstring

Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

fqdnstring

Output only. The FQDN created by combining the hostname and dns suffix. Should include a trailing dot.

dnsSuffixstring

Required. Immutable. The dns suffix for this record to use in longest-suffix matching. Requires a trailing dot. Example: "example.com."

serviceClassstring

Required. Immutable. The service class identifier which authorizes this AutomatedDnsRecord. Any API calls targeting this AutomatedDnsRecord must have networkconnectivity.serviceClasses.use IAM permission for the provided service class.

updateTimestring google-datetime

Output only. The timestamp of when the record was updated.

hostnamestring

Required. Immutable. The hostname for the DNS record. This value will be prepended to the dns_suffix to create the full domain name (FQDN) for the record. For example, if hostname is "corp.db" and dns_suffix is "example.com.", the resulting record will be "corp.db.example.com.". Should not include a trailing dot.

Response

Successful response