List the advisor's checks.

GET

/v1/advisor/checks

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/advisor/checks \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

. The catalog of checks the advisor runs: what each looks for, its severity, why it matters and how to fix it. It describes the platform, not any tenant, so every project binding may read it (Cedar advisor:ListChecks).

Authorizations

• bearerAuth

Responses

200

Checks.

Media typeapplication/json

object

items

required

Array<object>

. One kind of problem the advisor looks for.

object

id

required

string

service

required

string

resourceType

required

string

severity

required

string

Allowed values: low medium high

title

required

string

why

required

What the problem breaks.

string

fix

required

How to clear it.

string

Example

{
  "items": [
    {
      "id": "lb.no-listeners",
      "severity": "low"
    }
  ]
}

403

Authenticated but not authorized.

Media typeapplication/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"
    }
  ]
}