更新时间:2024-07-11 GMT+08:00

查询DDM指定实例的参数详情

功能介绍

查询DDM指定实例的参数详情。

接口约束

URI

GET /v3/{project_id}/instances/{instance_id}/configurations?offset={offset}&limit={limit}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。

获取方法请参见获取项目ID

instance_id

String

DDM实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

索引位置,偏移量。

从第一条数据偏移offset条数据后开始查询,默认为0。

取值必须为数字,且不能为负数。

limit

Integer

查询个数上限值。

取值范围:1~128。

不传该参数时,默认值为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

语种,默认中文。中文:zh-cn,英文:en-us。

X-Auth-Token

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

updated

String

DDM参数最后更新时间。

configuration_parameter

Array of ConfigurationParameterList objects

DDM实例参数信息列表的集合。

offset

Integer

分页参数: 起始值。

limit

Integer

分页参数:每页多少条。

total

Integer

集合总数。

表5 ConfigurationParameterList

参数

参数类型

描述

name

String

参数名称。

value

String

参数值。

need_restart

String

是否需要重启实例。

read_only

String

参数是否只读。

value_range

String

参数取值范围。

data_type

String

参数类型。

description

String

参数描述。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

请求示例

查询指定实例的参数详情。

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/configurations?offset={offset}&limit={limit}

响应示例

状态码: 200

OK

{
  "updated" : "2021-11-09 03:26:52",
  "configuration_parameter" : [ {
    "name" : "temp_table_size_limit",
    "value" : "1000000",
    "need_restart" : "0",
    "read_only" : "0",
    "value_range" : "500000-2000000000",
    "data_type" : "integer",
    "description" : "Maximum size of the temporary table."
  } ],
  "offset" : 0,
  "limit" : 128,
  "total" : 22
}

状态码: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

状态码

状态码

描述

200

OK

400

bad request

500

server error

错误码

请参见错误码