更新时间:2024-09-04 GMT+08:00

获取指定实例的参数模板

功能介绍

获取指定实例的参数模板信息。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/configurations

  • 参数说明
    表1 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    参数解释

    租户在某一Region下的项目ID。

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

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    String

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例
    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    datastore_version_name

    String

    参数解释

    数据库版本名称。

    取值范围

    不涉及。

    datastore_name

    String

    参数解释

    数据库名称。

    取值范围

    不涉及。

    created

    String

    参数解释

    创建时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。

    其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

    取值范围

    不涉及。

    updated

    String

    参数解释

    更新时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。

    其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

    取值范围

    不涉及。

    configuration_parameters

    Array of objects

    参数解释

    参数对象,用户基于默认参数模板自定义的参数配置。

    详情请参见表3

    表3 configuration_parameters字段数据结构说明

    名称

    参数类型

    说明

    name

    String

    参数解释

    参数名称。

    取值范围

    不涉及。

    value

    String

    参数解释

    参数值。

    取值范围

    不涉及。

    restart_required

    Boolean

    参数解释

    是否需要重启。

    取值范围

    • “false”表示否。
    • “true”表示是。

    readonly

    Boolean

    参数解释

    是否只读。

    取值范围

    • “false”表示否。
    • “true”表示是。

    value_range

    String

    参数解释

    参数值范围。

    取值范围

    如Integer取值0-1、Boolean取值true或者false等。

    type

    String

    参数解释

    参数类型。

    取值范围

    取值为“string”、“integer”、“boolean”、“list”或“float”之一。

    description

    String

    参数解释

    参数描述。

    取值范围

    不涉及。

  • 正常响应样例
    {
    	"datastore_version_name": "5.7",
    	"datastore_name": "mysql",
    	"created": "2018-10-11 11:40:44",
    	"updated": "2018-10-11 11:40:44",
    	"configuration_parameters": [{
    		"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列的操作。"
    	}]
    }
  • 异常响应

    请参见异常请求结果

状态码