Hoppa till innehållet
Stackship-dokumentation English

ResursgrupperAnvändareMaskinöversatt

API-referens

Alla HTTP-slutpunkter i modulen resource-groups: 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.

Docs

GET /docs/resource-groups/manifest.json

  • Autentisering: krävs
  • Operationsnamn: DocsManifest_resource-groups

Svar

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

GET /docs/resource-groups/{path}

  • Autentisering: krävs
  • Operationsnamn: DocsFile_resource-groups

Parametrar

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

Svar

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

Generic Resources

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources

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

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/{resourceName}/validate

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

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resources

  • Autentisering: krävs
  • Operationsnamn: ListAllResources

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resources/config

  • Autentisering: krävs
  • Operationsnamn: GetResourcesConfig

Parametrar

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

Svar

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

Resource Groups

GET /boundaries/{boundaryId}/resourcegroups

  • Autentisering: krävs
  • Operationsnamn: ListResourceGroups

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/config

  • Autentisering: krävs
  • Operationsnamn: GetResourceGroupsConfig

Parametrar

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

Svar

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

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}

  • Autentisering: krävs
  • IAM-åtgärd: resourcegroups/delete — utvärderas på resursen i sökvägen
  • Operationsnamn: DeleteResourceGroup

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}

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

Parametrar

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

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}

  • Autentisering: krävs
  • IAM-åtgärd: resourcegroups/write — utvärderas på resursen i sökvägen
  • Operationsnamn: CreateResourceGroup

Parametrar

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

Begärans innehåll: CreateResourceGroupRequest

Svar

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

GET /resourcegroups/by-namespace/{namespaceName}

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

Parametrar

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

Svar

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

GET /resourcegroups/orphaned-grants

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

Svar

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

POST /resourcegroups/orphaned-grants/purge

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

Svar

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

Övriga slutpunkter

GET /readyz

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

Svar

Status Betydelse Innehåll

GET /version

  • Autentisering: ingen — anonyma anrop accepteras
  • Operationsnamn: Version_resource-groups

Svar

Status Betydelse Innehåll
200 OK

Scheman

CreateResourceGroupRequest

Inga egenskaper.