Hoppa till innehållet
Stackship-dokumentation English

BoundariesAnvändareMaskinöversatt

API-referens

Alla HTTP-slutpunkter i modulen boundaries: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.

Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.

Boundaries

GET /boundaries

  • Autentisering: krävs

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

POST /boundaries

  • Autentisering: krävs
  • IAM-åtgärd: boundaries/create — utvärderas på plattformens rot

Begärans innehåll: CreateBoundaryRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/create på det utvärderade omfånget

GET /boundaries/config

  • Autentisering: krävs
  • IAM-åtgärd: boundaries/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetBoundariesConfig

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}

  • Autentisering: krävs
  • IAM-åtgärd: boundaries/delete — utvärderas på plattformens rot

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/delete på det utvärderade omfånget

GET /boundaries/{boundaryId}

  • Autentisering: krävs
  • IAM-åtgärd: boundaries/read — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/read på det utvärderade omfånget

PATCH /boundaries/{boundaryId}

  • Autentisering: krävs
  • IAM-åtgärd: boundaries/manage — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: UpdateBoundaryRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/manage på det utvärderade omfånget

POST /boundaries/{boundaryId}/tenant

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: MoveBoundaryTenantRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/tenant/admin på det utvärderade omfånget

Boundary Members

GET /boundaries/{boundaryId}/members

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/members/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/members

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: AddBoundaryMemberRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/members/manage på det utvärderade omfånget

GET /boundaries/{boundaryId}/members/config

  • Autentisering: krävs
  • IAM-åtgärd: boundaries/members/read — utvärderas på resursen i sökvägen
  • Operationsnamn: GetBoundaryMemberConfig

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/members/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/members/{assignmentId}

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
assignmentId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/members/manage på det utvärderade omfånget

Boundary Network

POST /boundaries/{boundaryId}/network/check

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: NetworkCheckRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/network/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/network/denies

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
direction frågesträng string Nej
pageSize frågesträng integer Nej
resource frågesträng string Nej
resourceGroup frågesträng string Nej
window frågesträng string Nej

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/network/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/network/denies/{denyId}

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
denyId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/network/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/network/graph

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup frågesträng string Nej
window frågesträng string Nej

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/network/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/network/series

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resource frågesträng string Nej
resourceGroup frågesträng string Nej
window frågesträng string Nej

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/network/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/network/status

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/network/read på det utvärderade omfånget

Boundary Projections

GET /boundaries/{boundaryId}/projections

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/projections/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/projections

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: CreateBoundaryProjectionRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/projections/manage på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/projections/{projectionId}

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
projectionId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/projections/manage på det utvärderade omfånget

GET /boundaries/{boundaryId}/projections/{projectionId}

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
projectionId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/projections/read på det utvärderade omfånget

PATCH /boundaries/{boundaryId}/projections/{projectionId}

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
projectionId sökväg uuid Ja

Begärans innehåll: UpdateBoundaryProjectionRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/projections/manage på det utvärderade omfånget
  • Autentisering: krävs
  • IAM-åtgärd: boundaries/read — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/read på det utvärderade omfånget
  • Autentisering: krävs
  • IAM-åtgärd: crosslink/admin — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: UpdateCrosslinkRequest

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte crosslink/admin på det utvärderade omfånget
  • Autentisering: krävs
  • IAM-åtgärd: crosslink/admin — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte crosslink/admin på det utvärderade omfånget

POST /boundaries/{boundaryId}/crosslink/access-grant

  • Autentisering: krävs
  • IAM-åtgärd: crosslink/admin — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: CrosslinkAccessGrantDto

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte crosslink/admin på det utvärderade omfånget
  • Autentisering: krävs
  • IAM-åtgärd: boundaries/read — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte boundaries/read på det utvärderade omfånget
  • Autentisering: krävs
  • IAM-åtgärd: crosslink/admin — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte crosslink/admin på det utvärderade omfånget
  • Autentisering: krävs
  • IAM-åtgärd: crosslink/admin — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
clusterId frågesträng uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte crosslink/admin på det utvärderade omfånget

POST /boundaries/{boundaryId}/crosslink/pki/rotate

  • Autentisering: krävs
  • IAM-åtgärd: crosslink/admin — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte crosslink/admin på det utvärderade omfånget

POST /boundaries/{boundaryId}/crosslink/status

  • Autentisering: krävs
  • IAM-åtgärd: crosslink/admin — utvärderas på resursen i sökvägen

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja

Begärans innehåll: CrosslinkStatusReport

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token
403 Anroparen har inte crosslink/admin på det utvärderade omfånget

Docs

GET /docs/boundaries/manifest.json

  • Autentisering: krävs
  • Operationsnamn: DocsManifest_boundaries

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

GET /docs/boundaries/{path}

  • Autentisering: krävs
  • Operationsnamn: DocsFile_boundaries

Parametrar

Namn Plats Typ Obligatorisk
path sökväg string Ja

Svar

Status Betydelse Innehåll
200 OK
401 Inte inloggad, eller ogiltig token

Övriga slutpunkter

GET /readyz

  • Autentisering: ingen — anonyma anrop accepteras
  • Operationsnamn: StackshipReadiness

Svar

Status Betydelse Innehåll

Scheman

AddBoundaryMemberRequest

Egenskap Typ Kan vara null
principalId uuid Nej
principalType string Ja
roleDefinitionName string Nej

CreateBoundaryProjectionRequest

Egenskap Typ Kan vara null
clusterId uuid Nej
namespaces string [] Ja

CreateBoundaryRequest

Egenskap Typ Kan vara null
displayName string Nej
Egenskap Typ Kan vara null
caPem string Nej
code string Nej
expiresUtc date-time Nej
hubEndpoint string Nej
url string Nej
Egenskap Typ Kan vara null
certificatePem string Nej
expiresUtc date-time Nej
fingerprint string Nej
issuedUtc date-time Nej
version integer Nej
Egenskap Typ Kan vara null
clusterId uuid Nej
isConflict boolean Nej
kind string Nej
namespace string Nej
podSelector string Ja
publishedPort integer Nej
routingKey string Nej
serviceName string Nej
statusReason string Ja

Ett av: 0 = NotApplicable, 1 = Connecting, 2 = Connected, 3 = Disconnected.

Egenskap Typ Kan vara null
clusterId uuid Nej
linkStatus CrosslinkLinkStatus Nej
observedPkiVersion integer Ja
role CrosslinkSiteRole Nej
status CrosslinkSiteStatus Nej
statusReason string Ja

Ett av: 0 = Hub, 1 = Spoke.

Ett av: 0 = Provisioning, 1 = Active, 2 = Degraded, 3 = Failed.

Egenskap Typ Kan vara null
ca CrosslinkCaReport Ja
exposures CrosslinkExposureReport [] Nej
observedAtUtc date-time Nej
sites CrosslinkSiteReport [] Nej

MoveBoundaryTenantRequest

Egenskap Typ Kan vara null
tenantId uuid Ja

NetworkCheckEndpointRequest

Egenskap Typ Kan vara null
kind string Nej
labels map (string) Ja
name string Ja
resourceGroup string Ja
value string Ja

NetworkCheckRequest

Egenskap Typ Kan vara null
clusterId uuid Ja
from NetworkCheckEndpointRequest Nej
port integer Nej
protocol string Nej
to NetworkCheckEndpointRequest Nej

UpdateBoundaryProjectionRequest

Egenskap Typ Kan vara null
namespaces string [] Ja

UpdateBoundaryRequest

Egenskap Typ Kan vara null
displayName string Nej
Egenskap Typ Kan vara null
enabled boolean Nej
hubClusterId uuid Ja