更新时间:2024-03-29 GMT+08:00
分享

获取参数模板列表

功能介绍

获取参数模板列表,包括所有数据库的默认参数模板和用户创建的参数模板。

该接口计划于2025-03-31下线,建议及时切换到新接口获取参数模板列表

接口约束

该接口支持如下数据库实例:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/configurations

  • URI样例

    https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一region下的project ID。获取方法请参见获取项目ID

请求消息

无。

响应消息

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

    名称

    参数类型

    说明

    count

    Integer

    总记录数

    configurations

    Array of objects

    参数模板列表。

    详情请参见表3

    表3 configurations字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    参数模板ID。

    name

    String

    参数模板名称。

    description

    String

    参数模板描述。

    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。

    user_defined

    Boolean

    是否是用户自定义参数模板。

    • 取值为“false”,表示为系统默认参数模板。
    • 取值为“true”,表示为用户自定义参数模板。
  • 正常响应样例
    { 
        "count": 2,
        "configurations": [{ 
                "id": "887ea0d1bb0843c49e8d8e5a09a95652pr06", 
                "name": "configuration_test", 
                "description": "configuration_test", 
                "datastore_version_name": "3.11", 
                "datastore_name": "cassandra", 
                "created": "2019-05-15T11:53:34+0000", 
                "updated": "2019-05-15T11:53:34+0000", 
                "user_defined": true 
            }, 
            { 
                "id": "3bc1e9cc0d34404b9225ed7a58fb284epr06", 
                "name": "Default-Cassandra-3.11", 
                "description": "Default parameter group for cassandra 3.11", 
                "datastore_version_name": "3.11", 
                "datastore_name": "cassandra", 
                "created": "2020-03-21T03:38:51+0000", 
                "updated": "2019-03-21T03:38:51+0000", 
                "user_defined": false 
            } 
        ] 
    }

状态码

详情请参见状态码

错误码

详情请参见错误码

相关文档