获取租户级全局配置
功能介绍
该接口用于获取租户级全局配置。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/ttsc/tenant-configs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
查询偏移量,若超过最大数量，则返回最后一页 取值范围： 0-2147483647 默认取值： 0 |
|
limit |
否 |
Integer |
查询数量 取值范围： 1-1000 默认取值： 10 |
|
key |
否 |
String |
类型 租户级自定义读法全局开关:vocabulary |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Request-Id |
否 |
String |
请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用uuId，若不携带，则后台自动生成 |
|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息。 |
|
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总记录数。 取值范围： 0-2147483647 |
|
data |
Array of SaveTtscTenantConfigsRequestBody objects |
租户级的开关列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
主键id |
|
key |
String |
租户级的配置项，当前只用于词表 |
|
value |
String |
租户级的配置项的值 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
业务返回码
|
|
error_msg |
String |
返回描述 |
|
request_id |
String |
请求唯一标识 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
业务返回码
|
|
error_msg |
String |
返回描述 |
|
request_id |
String |
请求唯一标识 |
请求示例
GET https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/tenant-configs
响应示例
状态码：200
处理成功。
{
"count" : 1,
"data" : [ {
"id" : "90247b5e90247b5e90247b5e11111111",
"key" : "vocabulary",
"value" : true
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功。 |
|
400 |
参数异常 |
|
500 |
服务端异常 |
错误码
请参见错误码。
