文档首页/代码托管 CodeArts Repo/API参考/API/V4/Tenant/获取租户设置 - ShowProjectTenantSettings
更新时间:2026-04-07 GMT+08:00
分享

获取租户设置 - ShowProjectTenantSettings

功能介绍

获取租户设置

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

当前API调用无需身份策略权限。

URI

GET /v4/tenant/setting

表1 Query参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。project_id赋值传参时表示查询的是项目所有者对应租户的设置

取值范围:

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

default_encryption_enabled

Boolean

参数解释:

仓库默认加密设置是否开启。

encryption_type

String

参数解释:

租户设置的加密类型。

取值范围:

KMS,normal,null,当为KMS时表示开启了KMS加密。

permit_public

String

参数解释:

允许公共访问。

取值范围:

allow 允许 deny 拒绝。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/tenant/setting

响应示例

状态码:200

OK

{
  "default_encryption_enabled" : true,
  "encryption_type" : "KMS",
  "permit_public" : "allow"
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码:403

Bad Request

{
  "error_code" : "DEV-23-50804",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码

相关文档