查询数据库代理内核参数
URI
GET /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/configurations
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
proxy_id |
是 |
String |
参数解释: 数据库代理ID,严格匹配UUID规则。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为po01,长度为36个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释: 查询记录数。 约束限制: 必须为整数,不能为负数。 取值范围: 1-100。 默认取值: 100。 |
offset |
否 |
Integer |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为整数,不能为负数。 取值范围: ≥0。 默认取值: 0。 |
name |
否 |
String |
参数解释: 参数名称,为空则全量查询。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 内容类型。 约束限制: 不涉及。 取值范围: application/json。 默认取值: application/json。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
String |
参数解释: 数据总数。 取值范围: 不涉及。 |
configurations |
Array of ProxyConfiguration objects |
参数解释: 内核可配置的参数列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 参数名称。 取值范围: 不涉及。 |
data_type |
String |
参数解释: 参数数据类型。 取值范围: 不涉及。 |
elem_type |
String |
参数解释: 参数父标签类型。 取值范围: 不涉及。 |
value_range |
String |
参数解释: 参数取值范围。 取值范围: 不涉及。 |
value |
String |
参数解释: 参数默认值。 取值范围: 不涉及。 |
description |
String |
参数解释: 参数描述。 取值范围: 不涉及。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询数据库代理内核参数。
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/151c14381ac14ecfb9703a745b992677po01/configurations
响应示例
状态码: 200
Success.
{ "total_count" : 1, "configurations" : [ { "name" : "slowLogQueryTime", "data_type" : "integer", "elem_type" : "system", "value_range" : "200-50000", "value" : 500, "description" : "proxy慢日志阈值,默认值为500,单位ms。" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。