Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

7.21. 超级用户

超级用户 API。

7.21.1. createInstallUser
复制链接

创建新用户。

POST /api/v1/superuser/users/

授权： oauth2_implicit (超级：user)

请求正文模式(application/json)

创建用户的数据

Expand
名称描述模式

需要 的用户名

正在创建的用户的用户名

字符串

email
可选

正在创建的用户的电子邮件地址

字符串

响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X POST -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json" -d '{
  "username": "newuser",
  "email": "newuser@example.com"
}' "https://<quay-server.example.com>/api/v1/superuser/users/"
Copy to Clipboard Toggle word wrap

7.21.2. deleteInstallUser
复制链接

删除用户。

DELETE /api/v1/superuser/users/{username}

授权： oauth2_implicit (超级：user)

请求正文模式(application/json)

删除用户的数据

Expand
Name描述模式

需要 的用户名

要删除的用户的用户名

string

响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X DELETE -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/{username}"
Copy to Clipboard Toggle word wrap

7.21.3. listAllUsers
复制链接

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

GET /api/v1/superuser/users/

授权： oauth2_implicit (超级：user)

查询参数
Expand
类型Name描述模式

query

next_page
optional

下一页面的页面令牌

字符串

query

限制
可选

限制为每个页面返回的结果数。最大 100。

整数

query

禁用
可选

如果为 false，则仅返回启用的用户。

布尔值

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/"
Copy to Clipboard Toggle word wrap

7.21.4. listAllLogs
复制链接

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

GET /api/v1/superuser/logs

授权： oauth2_implicit (超级：user)

查询参数
Expand
类型Name描述模式

query

next_page
optional

下一页面的页面令牌

字符串

query

页
可选

日志的页面号

整数

query

ENDTIME
可选

获取日志的最新时间(%m/%d/%Y %Z)

字符串

query

startTime
可选

从中获取日志的最早时间(%m/%d/%Y %Z)

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://<quay_server>/api/v1/superuser/logs?starttime=<start_time>&endtime=<end_time>&page=<page_number>&next_page=<next_page_token>"
Copy to Clipboard Toggle word wrap

7.21.5. listAllOrganizations
复制链接

列出当前系统的机构。

GET /api/v1/superuser/organizations

授权： oauth2_implicit (超级：user)

查询参数
Expand
类型Name描述模式

path

name
必需

受管机构的名称

string

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/organizations/"
Copy to Clipboard Toggle word wrap

7.21.6. createServiceKey
复制链接

POST /api/v1/superuser/keys

授权： oauth2_implicit (超级：user)

请求正文模式(application/json)

创建服务密钥的描述

Expand
名称描述模式

需要 服务

使用这个密钥验证的服务

string

name
可选

服务密钥的友好名称

string

元数据
可选

此键元数据的键/值对

对象

notes
可选

如果指定，键的额外备注

string

过期

过期日期为 unix 时间戳

 
响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "service": "<service_name>",
        "expiration": <unix_timestamp>
      }' \
  "<quay_server>/api/v1/superuser/keys"
Copy to Clipboard Toggle word wrap

7.21.7. listServiceKeys
复制链接

GET /api/v1/superuser/keys

授权： oauth2_implicit (超级：user)

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://<quay_server>/api/v1/superuser/keys"
Copy to Clipboard Toggle word wrap

7.21.8. changeUserQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

path

quota_id
required

 

字符串

请求正文模式(application/json)

新机构配额的描述

Expand
名称描述模式

limit_bytes
optional

允许机构的字节数

整数

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X PUT "https://quay-server.example.com/api/v1/superuser/organization/<namespace>/quota/<quota_id>" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "limit_bytes": <NEW_QUOTA_LIMIT>
  }'
Copy to Clipboard Toggle word wrap

7.21.9. deleteUserQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

path

quota_id
required

 

字符串

响应
Expand
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X DELETE "https://quay-server.example.com/api/v1/superuser/organization/<namespace>/quota/<quota_id>" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
Copy to Clipboard Toggle word wrap

7.21.10. createUserQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

请求正文模式(application/json)

新机构配额的描述

Expand
名称描述模式

limit_bytes
required

允许机构的字节数

整数

响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X POST "https://quay-server.example.com/api/v1/superuser/organization/<namespace>/quota" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "limit_bytes": 10737418240
  }'
Copy to Clipboard Toggle word wrap

7.21.11. listUserQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET "https://quay-server.example.com/api/v1/superuser/organization/<namespace>/quota" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
Copy to Clipboard Toggle word wrap

7.21.12. changeOrganizationQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

path

quota_id
required

 

字符串

请求正文模式(application/json)

新机构配额的描述

Expand
名称描述模式

limit_bytes
optional

允许机构的字节数

整数

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X PUT "https://quay-server.example.com/api/v1/superuser/users/<username>/quota/<quota_id>" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "limit_bytes": <NEW_QUOTA_LIMIT>
  }'
Copy to Clipboard Toggle word wrap

7.21.13. deleteOrganizationQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

path

quota_id
required

 

字符串

响应
Expand
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X DELETE "https://quay-server.example.com/api/v1/superuser/users/<username>/quota/<quota_id>" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
Copy to Clipboard Toggle word wrap

7.21.14. createOrganizationQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

请求正文模式(application/json)

新机构配额的描述

Expand
名称描述模式

limit_bytes
optional

允许机构的字节数

整数

响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X POST "https://quay-server.example.com/api/v1/superuser/users/<username>/quota" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "limit_bytes": <QUOTA_LIMIT>
      }'
Copy to Clipboard Toggle word wrap

7.21.15. listOrganizationQuotaSuperUser
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET "https://quay-server.example.com/api/v1/superuser/users/<username>/quota" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
Copy to Clipboard Toggle word wrap

7.21.16. changeOrganization
复制链接

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

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

name
必需

受管机构的的名称

字符串

请求正文模式(application/json)

现有机构的更新描述

Expand
名称描述模式

email
可选

机构联系电子邮件

字符串

invoice_email
optional

机构是否希望接收发票的电子邮件

布尔值

invoice_email_address
optional

要接收发票的电子邮件地址

 

tag_expiration_s
optional

标签过期的秒数

整数

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "email": "<contact_email>",
        "invoice_email": <boolean_value>,
        "invoice_email_address": "<invoice_email_address>",
        "tag_expiration_s": <expiration_seconds>
      }' \
  "https://<quay_server>/api/v1/superuser/organizations/<organization_name>"
Copy to Clipboard Toggle word wrap

7.21.17. deleteOrganization
复制链接

删除指定的机构。

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

name
必需

受管机构的的名称

字符串

响应
Expand
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "https://<quay_server>/api/v1/superuser/organizations/<organization_name>"
Copy to Clipboard Toggle word wrap

7.21.18. approveServiceKey
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

kid
必需

服务密钥的唯一标识符

字符串

请求正文模式(application/json)

批准服务密钥的信息

Expand
名称描述模式

notes
可选

可选的批准备注

字符串

响应
Expand
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X POST \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "notes": "<approval_notes>"
      }' \
  "https://<quay_server>/api/v1/superuser/approvedkeys/<kid>"
Copy to Clipboard Toggle word wrap

7.21.19. deleteServiceKey
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

kid
必需

服务密钥的唯一标识符

字符串

响应
Expand
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X DELETE \
  -H "Authorization: Bearer <bearer_token>" \
  "https://<quay_server>/api/v1/superuser/keys/<kid>"
Copy to Clipboard Toggle word wrap

7.21.20. updateServiceKey
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

kid
必需

服务密钥的唯一标识符

字符串

请求正文模式(application/json)

服务密钥更新的描述

Expand
名称描述模式

name
可选

服务密钥的友好名称

字符串

元数据
可选

此键元数据的键/值对

对象

过期
可选

过期日期为 unix 时间戳

 
响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X PUT \
  -H "Authorization: Bearer <bearer_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "<service_key_name>",
        "metadata": {"<key>": "<value>"},
        "expiration": <unix_timestamp>
      }' \
  "https://<quay_server>/api/v1/superuser/keys/<kid>"
Copy to Clipboard Toggle word wrap

7.21.21. getServiceKey
复制链接

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

kid
必需

服务密钥的唯一标识符

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://<quay_server>/api/v1/superuser/keys/<kid>"
Copy to Clipboard Toggle word wrap

7.21.22. getRepoBuildStatusSuperUser
复制链接

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

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

build_uuid
required

构建的 UUID

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET "https://quay-server.example.com/api/v1/superuser/<build_uuid>/status" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
Copy to Clipboard Toggle word wrap

7.21.23. getRepoBuildSuperUser
复制链接

返回有关构建的信息。

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

build_uuid
required

构建的 UUID

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET "https://quay-server.example.com/api/v1/superuser/<build_uuid>/build" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
Copy to Clipboard Toggle word wrap

7.21.24. getRepoBuildLogsSuperUser
复制链接

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

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

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

build_uuid
required

构建的 UUID

字符串

响应
Expand
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET "https://quay-server.example.com/api/v1/superuser/<build_uuid>/logs" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
Copy to Clipboard Toggle word wrap

7.21.25. getRegistrySize
复制链接

GET /api/v1/superuser/registrysize/

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

string

镜像 registry 大小的描述

Expand
Name描述模式

size_bytes*
optional

允许机构的字节数

整数

last_ran

 

整数

Queued

 

布尔值

running

 

布尔值

响应
Expand
HTTP 代码描述模式

200

已创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X GET \
  -H "Authorization: Bearer <bearer_token>" \
  "https://<quay_server>/api/v1/superuser/registrysize/"
Copy to Clipboard Toggle word wrap

7.21.26. postRegistrySize
复制链接

POST /api/v1/superuser/registrysize/

授权： oauth2_implicit (超级：user)

路径参数
Expand
类型Name描述模式

path

namespace
必需

 

字符串

请求正文模式(application/json)

镜像 registry 大小的描述

Expand
Name描述模式

last_ran

 

整数

Queued

 

布尔值

running

 

布尔值

响应
Expand
HTTP 代码描述模式

201

已创建

 

400

错误请求

ApiError

401

需要会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

示例命令
$ curl -X POST "https://quay-server.example.com/api/v1/superuser/registrysize/" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "namespace": "<namespace>",
    "last_ran": 1700000000,
    "queued": true,
    "running": false
  }'
Copy to Clipboard Toggle word wrap
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat