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