API-referens

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/jobs/manifest.json

• Autentisering: krävs
• Operationsnamn: DocsManifest_jobs

Svar

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

GET /docs/jobs/{path}

• Autentisering: krävs
• Operationsnamn: DocsFile_jobs

Parametrar

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

Svar

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

Jobs

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

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

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 jobs/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/jobs/{jobName}

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

Parametrar

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

Svar

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

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

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

Parametrar

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

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/jobs/{jobName}

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

Parametrar

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

Begärans innehåll: JobDto

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/jobs/{jobName}/logs

• Autentisering: krävs
• IAM-åtgärd: jobs/readLogs — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

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

Svar

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

Övriga slutpunkter

GET /readyz

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

Svar

Status	Betydelse	Innehåll

Scheman

JobDto

Egenskap	Typ	Kan vara null
activeDeadlineSeconds	integer	Nej
clusterId	uuid	Ja
completedAt	date-time	Ja
computePlan	string	Nej
createdAt	date-time	Ja
env	map (string)	Nej
image	string	Nej
name	string	Ja
resourceGroup	string	Ja
status	string	Ja
tag	string	Nej
ttlSecondsAfterFinished	integer	Nej