获取指定实例的参数信息
URI
GET /v3/{project_id}/instances/{instance_id}/configurations
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID，严格匹配UUID规则。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 |
limit |
否 |
Integer |
查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围：
|
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
configurations |
ParameterConfigurationInfo object |
参数信息。 |
total_count |
Long |
参数信息的总数。 |
parameter_values |
Array of ParameterValuesInfo objects |
参数对象。 |
参数 |
参数类型 |
描述 |
|---|---|---|
datastore_version_name |
String |
数据库版本名称。 |
datastore_name |
String |
数据库名称。 |
created |
String |
创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 |
updated |
String |
更新时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 |
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
参数名称。 |
value |
String |
参数值。 |
restart_required |
Boolean |
是否需要重启。
|
readonly |
Boolean |
是否只读。
|
value_range |
String |
参数值范围，如Integer取值0-1、Boolean取值true|false等。 |
type |
String |
参数类型,可取取值如下：
|
description |
String |
参数描述。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
获取指定实例的参数信息。
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/configurations
响应示例
状态码： 200
Success.
{
"configurations" : {
"datastore_version_name" : 2.0,
"datastore_name" : "taurus",
"created" : "2022-10-29T09:38:36+0000",
"updated" : "2022-10-29T09:38:36+0000"
},
"total_count" : 125,
"parameter_values" : [ {
"name" : "auto_increment_increment",
"value" : 1,
"restart_required" : false,
"readonly" : false,
"value_range" : "1-65535",
"type" : "integer",
"description" : "auto_increment_increment和auto_increment_offset 用于master-to-master的复制，并可以用来控制AUTO_INCREMENT列的操作。"
}, {
"name" : "auto_increment_offset",
"value" : 1,
"restart_required" : false,
"readonly" : false,
"value_range" : "1-65535",
"type" : "integer",
"description" : "auto_increment_increment和auto_increment_offset用于master-to-master的复制，并可以用来控制AUTO_INCREMENT列的操作。"
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。
