# 获取指定实例的参数信息-ObtainingParametersofaSpecifiedDBInstance #### 接口说明 获取指定实例的参数信息。 #### 约束说明 该接口仅支持DDS社区版。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ShowEntityConfiguration)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:getConfiguration | read | instance | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | dds:param:list | - | #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/configurations - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f0ba99dd8a8249838a6007042d76b07ain02/configurations?entity_id=827697ee2f6040bd9fcf65586e3f7218gr02 #### 请求消息 参数说明 表1请求参数参数 | 参数 | 类型 | IN | 是否必选 | 描述 | |:---|:---|:---|:---|:---| | X-Auth-Token | string | header | 是 | 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 | | Content-Type | string | header | 是 | 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 | | project_id | string | path | 是 | 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 | | instance_id | string | path | 是 | 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 | 表2Query参数 | 参数 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | entity_id | String | 是 | - 实例ID或组ID或节点ID。可以调用"查询实例列表和详情"接口获取。如果未申请实例，可以调用"创建实例"接口创建。 - 当获取的实例类型是集群，如果获取的是shard组或者config组的参数模板，传值为组ID。如果获取的是mongos节点的参数模板，传值为节点ID。 - 当获取的实例类型是副本集或单节点，传值为实例ID。 | #### 响应消息 - 参数说明 表3响应Body参数 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | datastore_version | String | 数据库版本。 | | datastore_name | String | 数据库类型。 | | created | String | 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | updated | String | 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | parameters | Array of objects | 参数对象，用户基于默认参数模板自定义的参数配置。 详情请参见[表4]。 | 表4parameters字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | name | String | 参数名称。 | | value | String | 参数值。 | | value_range | String | 参数值范围。 示例：Integer类型取值范围为0\~1、Boolean类型取值为"true"或"false"。 | | restart_required | Boolean | 参数是否需要重启。 - 取值为"true"，需要重启。 - 取值为"false"，不需要重启。 | | readonly | Boolean | 是否只读。 - 取值为"false"，非只读参数。 - 取值为"true"，只读参数。 | | type | String | 参数类型，取值为"integer"，"string"，"boolean"，"float"或"list"。 | | description | String | 参数描述。 | - 响应示例 ``` { "datastore_version" : "4.0", "datastore_name" : "mongos", "created" : "2017-01-01T10:00:00", "updated" : "2017-01-01T10:00:00", "parameters" : [ { "name" : "cursorTimeoutMillis", "value" : 600000, "restart_required" : false, "readonly" : false, "description" : "设置空闲游标的超期时间，DDS将删除空闲的游标", "value_range" : "600000-1000000" } ] } ``` #### SDK 单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。