添加租户配置 - AddTenantConfig
功能介绍
添加租户配置。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartscheck::updateConfig | Write | - | - | - | - |
URI
POST /v1/tenant-configs
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为[1~100000]的字符。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 编码格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: application/json,传任何值,接口返回值均为json格式。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 租户配置的key。如果是配置租户检查语言,则以"languageFileSuffix_"开头,后面接租户检查语言。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| value | 是 | String | 参数解释: 租户配置的值。如果是配置租户检查语言,则值代表当前语言的文件后缀,多个文件后缀以英文逗号隔开。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 租户配置的ID。 取值范围: 不涉及。 |
| key | String | 参数解释: 租户配置的key。如果是配置租户检查语言,则以"languageFileSuffix_"开头,后面接租户检查语言。 取值范围: 不涉及。 |
| value | String | 参数解释: 租户配置的值。如果是配置租户检查语言,则值代表当前语言的文件后缀,多个文件后缀以英文逗号隔开。 取值范围: 不涉及。 |
| description | String | 参数解释: 租户配置的描述。 取值范围: 不涉及。 |
| create_time | String | 参数解释: 租户配置的创建时间。 取值范围: 不涉及。 |
| last_update_time | String | 参数解释: 租户配置的上一次更新时间。 取值范围: 不涉及。 |
| creator | String | 参数解释: 租户配置的创建人。 取值范围: 不涉及。 |
| last_reviser | String | 参数解释: 租户配置的上一次修改人。 取值范围: 不涉及。 |
| domain_id | String | 参数解释: 租户ID,值来源于IAM的租户ID。 取值范围: 不涉及。 |
| has_default_config | Boolean | 参数解释: 是否有默认配置项。例如,对于租户语言来说,系统语言有默认的文件后缀,值是true,租户自定义语言没有默认的文件后缀,值是false。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
添加一条key为languageFileSuffix_FORTRAN,value为f,f90,F的系统配置,实际上这个是在租户下新增了一条FORTRAN检查语言,文件后缀为f,f90,F。
POST https://{endpoint}/v1/tenant-configs
{
"key" : "languageFileSuffix_FORTRAN",
"value" : "f,f90,F"
} 响应示例
状态码:200
成功添加租户配置
{
"id" : "e97e5393cfb34add824b4019bf961cce",
"key" : "languageFileSuffix_FORTRAN",
"value" : "f,f90,F",
"description" : null,
"create_time" : null,
"creator" : null,
"last_reviser" : null,
"domain_id" : "389efb76b1354e4482eabeed25c895e4",
"has_default_config" : null,
"last_update_time" : null
} 状态码:400
请求异常。
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码:401
权限不足。
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功添加租户配置 |
| 400 | 请求异常。 |
| 401 | 权限不足。 |
错误码
请参见错误码。