2.20. superuser | Red Hat Product Documentation

2.20.1. createInstallUser

创建新用户。

POST /api/v1/superuser/users/

授权： oauth2_implicit (super:user)

请求正文模式(application/json)

用于创建用户的数据

名称	描述	模式
用户名可选	正在创建的用户的用户名	字符串
email 可选	正在创建的用户的电子邮件地址	字符串

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.2. listAllUsers

返回系统中所有用户的列表。

GET /api/v1/superuser/users/

授权： oauth2_implicit (super:user)

查询参数

类型	Name	描述	模式
query	next_page optional	下一页的页面令牌	字符串
query	限制可选	限制为每个页面返回的结果数。最大 100。	整数
query	禁用可选	如果为 false，则只返回启用的用户。	布尔值

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.3. listAllLogs

列出当前系统的使用日志。

GET /api/v1/superuser/logs

授权： oauth2_implicit (super:user)

查询参数

类型	Name	描述	模式
query	next_page optional	下一页的页面令牌	字符串
query	Page 可选	日志的页面号	整数
query	ENDTIME 可选	获取日志的最长时间(%m/%d/%Y %Z)	字符串
query	startTime 可选	从中获取日志的最早时间(%m/%d/%Y %Z)	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.4. createServiceKey

POST /api/v1/superuser/keys

授权： oauth2_implicit (super:user)

请求正文模式(application/json)

创建服务密钥的描述

名称	描述	模式
service 可选	使用此密钥进行服务进行身份验证	字符串
name 可选	服务密钥的友好名称	字符串
元数据可选	此键元数据的键/值对	对象
notes 可选	如果指定，键的额外备注	字符串
过期可选	作为 unix 时间戳的过期日期

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.5. listServiceKeys

GET /api/v1/superuser/keys

授权： oauth2_implicit (super:user)

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.6. changeUserQuotaSuperUser

PUT /api/v1/superuser/organization/{namespace}/quota/{quota_id}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串
path	quota_id required		字符串

请求正文模式(application/json)

新机构配额的描述

名称	描述	模式
limit_bytes optional	允许机构的字节数	整数

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.7. deleteUserQuotaSuperUser

DELETE /api/v1/superuser/organization/{namespace}/quota/{quota_id}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串
path	quota_id required		字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.8. createUserQuotaSuperUser

POST /api/v1/superuser/organization/{namespace}/quota

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串

请求正文模式(application/json)

新机构配额的描述

名称	描述	模式
limit_bytes optional	允许机构的字节数	整数

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.9. listUserQuotaSuperUser

GET /api/v1/superuser/organization/{namespace}/quota

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.10. changeOrganizationQuotaSuperUser

PUT /api/v1/superuser/users/{namespace}/quota/{quota_id}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串
path	quota_id required		字符串

请求正文模式(application/json)

新机构配额的描述

名称	描述	模式
limit_bytes optional	允许机构的字节数	整数

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.11. deleteOrganizationQuotaSuperUser

DELETE /api/v1/superuser/users/{namespace}/quota/{quota_id}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串
path	quota_id required		字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.12. createOrganizationQuotaSuperUser

POST /api/v1/superuser/users/{namespace}/quota

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串

请求正文模式(application/json)

新机构配额的描述

名称	描述	模式
limit_bytes optional	允许机构的字节数	整数

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.13. listOrganizationQuotaSuperUser

GET /api/v1/superuser/users/{namespace}/quota

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.14. changeOrganization

更新有关指定用户的信息。

PUT /api/v1/superuser/organizations/{name}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	name 必需	受管机构的的名称	字符串

请求正文模式(application/json)

现有机构的更新描述

名称	描述	模式
email 可选	机构联系电子邮件	字符串
invoice_email optional	组织是否需要接收发票的电子邮件	布尔值
invoice_email_address optional	要接收发票的电子邮件地址
tag_expiration_s optional	标签过期的秒数	整数

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.15. deleteOrganization

删除指定的组织。

DELETE /api/v1/superuser/organizations/{name}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	name 必需	受管机构的的名称	字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.16. approveServiceKey

POST /api/v1/superuser/approvedkeys/{kid}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	kid 必需	服务密钥的唯一标识符	字符串

请求正文模式(application/json)

批准服务密钥的信息

名称	描述	模式
notes 可选	可选批准备注	字符串

响应

HTTP 代码	描述	模式
201	成功创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.17. deleteServiceKey

DELETE /api/v1/superuser/keys/{kid}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	kid 必需	服务密钥的唯一标识符	字符串

响应

HTTP 代码	描述	模式
204	已删除
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.18. updateServiceKey

PUT /api/v1/superuser/keys/{kid}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	kid 必需	服务密钥的唯一标识符	字符串

请求正文模式(application/json)

服务密钥的更新描述

名称	描述	模式
name 可选	服务密钥的友好名称	字符串
元数据可选	此键元数据的键/值对	对象
过期可选	作为 unix 时间戳的过期日期

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.19. getServiceKey

GET /api/v1/superuser/keys/{kid}

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	kid 必需	服务密钥的唯一标识符	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.20. getRepoBuildStatusSuperUser

返回由构建 uuids 指定的构建状态。

GET /api/v1/superuser/{build_uuid}/status

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	build_uuid required	构建的 UUID	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.21. getRepoBuildSuperUser

返回有关构建的信息。

GET /api/v1/superuser/{build_uuid}/build

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	build_uuid required	构建的 UUID	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.22. getRepoBuildLogsSuperUser

返回由构建 uuid 指定的构建的构建日志。

GET /api/v1/superuser/{build_uuid}/logs

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	build_uuid required	构建的 UUID	字符串

响应

HTTP 代码	描述	模式
200	成功调用
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.23. getRegistrySize

GET /api/v1/superuser/registrysize/

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串

请求正文模式(application/json)

镜像 registry 大小的描述

Name	描述	模式
size_bytes* optional	允许机构的字节数	整数
last_ran		整数
Queued		布尔值
running		布尔值

响应

HTTP 代码	描述	模式
201	已创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError

2.20.24. postRegistrySize

POST /api/v1/superuser/registrysize/

授权： oauth2_implicit (super:user)

路径参数

类型	Name	描述	模式
path	namespace 必需		字符串

请求正文模式(application/json)

镜像 registry 大小的描述

Name	描述	模式
size_bytes* optional	允许机构的字节数	整数
last_ran		整数
Queued		布尔值
running		布尔值

响应

HTTP 代码	描述	模式
201	已创建
400	错误请求	ApiError
401	需要会话	ApiError
403	未授权访问	ApiError
404	未找到	ApiError