LocationService_GetLocations

GET 
/infra/v3/partner/{metadata.partner}/location

LocationService_GetLocations

Request

Path Parameters

metadata.partner stringrequired

Partner to which the resource belongs

Query Parameters

apiVersion stringrequired

Default value: infra.k8smgmt.io/v3

API Version

API Version of the resource

kind stringrequired

Default value: Location

Kind

Kind of the resource

metadata.name stringrequired

Name

name of the resource

metadata.displayName string

Display Name

display name of the resource

metadata.description string

Description

description of the resource

metadata.labels string

Labels

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

metadata.annotations string

Annotations

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

metadata.project stringrequired

Project

Project of the resource

metadata.organization string

Organization

Organization to which the resource belongs

metadata.id string
metadata.urlScope string
metadata.createdAt date-time
metadata.modifiedAt date-time
spec.id string

ID of Location

ID Location of the cluster

spec.name string

Location

Location of the cluster

spec.city string

City

City of the location

spec.state string

State

State of the location

spec.country string

Country

country of the location

spec.locale string

Locale

locale of the location

spec.latitude string

Latitude

Latitude of the location

spec.longitude string

Longitude

Longitude of the location

spec.countryCode string

CountryCode

CountryCode of the location

spec.stateCode string

StateCode

StateCode of the location

status.conditionType string

Condition Type

type of the status condition

status.conditionStatus string

Possible values: [StatusNotSet, StatusSubmitted, StatusOK, StatusFailed]

Default value: StatusNotSet

Condition Status

status of the condition

status.lastUpdated date-time

Last Updated

when the condition status is last updated

status.reason string

Reason

reason of the last condition status

Responses

200

A successful response.

application/json

Schema

Schema

apiVersion API Version

Default value: infra.k8smgmt.io/v3

API Version of the list resource

kind Kind

Default value: LocationList

Kind of the list resource

metadata object
Metadata of the list resource
count int64
offset int64
limit int64
items object[]
List of the resources
Array [
id ID of Location
ID Location of the cluster
name Location
Location of the cluster
city City
City of the location
state State
State of the location
country Country
country of the location
locale Locale
locale of the location
latitude Latitude
Latitude of the location
longitude Longitude
Longitude of the location
countryCode CountryCode
CountryCode of the location
stateCode StateCode
StateCode of the location
]

Example (from schema)

{
  "apiVersion": "infra.k8smgmt.io/v3",
  "kind": "LocationList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "id": "string",
      "name": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "locale": "string",
      "latitude": "string",
      "longitude": "string",
      "countryCode": "string",
      "stateCode": "string"
    }
  ]
}

application/yaml

Schema

Schema

apiVersion API Version

Default value: infra.k8smgmt.io/v3

API Version of the list resource

kind Kind

Default value: LocationList

Kind of the list resource

metadata object
Metadata of the list resource
count int64
offset int64
limit int64
items object[]
List of the resources
Array [
id ID of Location
ID Location of the cluster
name Location
Location of the cluster
city City
City of the location
state State
State of the location
country Country
country of the location
locale Locale
locale of the location
latitude Latitude
Latitude of the location
longitude Longitude
Longitude of the location
countryCode CountryCode
CountryCode of the location
stateCode StateCode
StateCode of the location
]

Example (from schema)

{
  "apiVersion": "infra.k8smgmt.io/v3",
  "kind": "LocationList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "id": "string",
      "name": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "locale": "string",
      "latitude": "string",
      "longitude": "string",
      "countryCode": "string",
      "stateCode": "string"
    }
  ]
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

404

Returned when the resource does not exist.

application/json

Schema

Schema

string

application/yaml

Schema

Schema

string

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/yaml

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...