The cluster's per-VPC DNS recursor replica setting, and how far it has converged.

GET

/v1/admin/network/dns/recursor-settings

Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/admin/network/dns/recursor-settings \
  --header 'Authorization: Bearer <token>'

How many replicas of each VPC’s recursor the cluster runs (1, or 2 for active/active), and the network-dns-recursor converger’s view of it: whether every DNS VPC is at the setting, and how many replicas the .3 resolvers still balance to. Seeded once from STRATUM_DNS_RECURSOR_REPLICAS; after that this setting is the only source. Install-scope; gates on network:GetDNSRecursorSettings.

Authorizations

bearerAuth

Responses

200

The setting and its status.

application/json

The cluster’s per-VPC recursor replica setting and the network-dns-recursor converger’s view of it.

object

replicas

required

The desired per-VPC replica count (always 1 on single-node).

integer

maxReplicas

required

The highest count this install accepts: 2 (the per-VPC DNS switch is a /29: a gateway and two replicas), 1 on single-node.

integer

singleNode

required

boolean

generation

required

Moves on every change of replicas.

integer format: int64

source

required

Seed: from STRATUM_DNS_RECURSOR_REPLICAS at first start; operator: set through this API.

string

Allowed values: seed operator

updatedBy

required

string

updatedAt

required

string format: date-time

status

How far the cluster has converged on the replica setting. Absent until the network-dns-recursor converger’s first pass.

object

phase

required

Converged when the last pass found every DNS VPC at the setting, for the current generation: its switch has the setting’s ports and its .3 balances to as many replicas as placement holds (fewer on a cluster with fewer ready nodes). converging otherwise, including right after a change and while a replica does not answer.

string

Allowed values: converged converging

observedGeneration

required

The setting generation the last pass worked to.

integer format: int64

servingReplicas

required

The most replicas any VPC’s .3 still balances to. The recursor sweeps keep that many placed, so a replica is never removed while it still takes flows.

integer

vpcs

required

DNS-resolving VPCs the last pass covered.

integer

vpcsConverged

required

integer

detail

The first VPC not at the setting, and why.

string

observedAt

required

When the converger last recorded a change, or refreshed an unchanged status (at least every two minutes while it runs).

string format: date-time

Example

{
  "source": "seed",
  "status": {
    "phase": "converged"
  }
}

403

Authenticated but not authorized.

application/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}

503

Upstream temporarily unavailable (driver / scheduler / dependency).

application/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}