6.2. API 端点
可用的 API 端点如下:
/apis/batch/v1/cronjobs
-
GET
: 列出或监视类型为 CronJob 的对象
-
/apis/batch/v1/watch/cronjobs
-
GET
: 观察单个对 CronJob 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs
-
DELETE
: delete collection of CronJob -
GET
: 列出或监视类型为 CronJob 的对象 -
POST
:创建 CronJob
-
/apis/batch/v1/watch/namespaces/{namespace}/cronjobs
-
GET
: 观察单个对 CronJob 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
-
DELETE
: delete a CronJob -
GET
:读取指定的 CronJob -
PATCH
: 部分更新指定的 CronJob -
PUT
:替换指定的 CronJob
-
/apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name}
-
GET
: 观察对类型为 CronJob 的对象的更改。已弃用:使用带有 list 操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
-
GET
:指定 CronJob 的读取状态 -
PATCH
: 部分更新指定 CronJob 的状态 -
PUT
:替换指定 CronJob 的状态
-
6.2.1. /apis/batch/v1/cronjobs
- HTTP 方法
-
GET
- 描述
- 列出或监视类型为 CronJob 的对象
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 | 空 |
6.2.2. /apis/batch/v1/watch/cronjobs
- HTTP 方法
-
GET
- 描述
- 观察单个对 CronJob 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
6.2.3. /apis/batch/v1/namespaces/{namespace}/cronjobs
- HTTP 方法
-
DELETE
- 描述
- 删除 CronJob 集合
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出或监视类型为 CronJob 的对象
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 | 空 |
- HTTP 方法
-
POST
- 描述
- create a CronJob
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - 未授权 | 空 |
6.2.4. /apis/batch/v1/watch/namespaces/{namespace}/cronjobs
- HTTP 方法
-
GET
- 描述
- 观察单个对 CronJob 列表的更改。已弃用:改为使用 'watch' 参数及列表操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
6.2.5. /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
参数 | 类型 | 描述 |
---|---|---|
|
| CronJob 的名称 |
- HTTP 方法
-
DELETE
- 描述
- delete a CronJob
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 读取指定的 CronJob
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的 CronJob
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - 未授权 | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的 CronJob
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - 未授权 | 空 |
6.2.6. /apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name}
参数 | 类型 | 描述 |
---|---|---|
|
| CronJob 的名称 |
- HTTP 方法
-
GET
- 描述
- 观察对类型为 CronJob 的对象的更改。已弃用:使用带列表操作的 'watch' 参数,而是过滤成带有 'fieldSelector' 参数的单个项目。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
6.2.7. /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
参数 | 类型 | 描述 |
---|---|---|
|
| CronJob 的名称 |
- HTTP 方法
-
GET
- 描述
- 指定 CronJob 的读取状态
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定 CronJob 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - 未授权 | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定 CronJob 的状态
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - 未授权 | 空 |