云服务器内容精选

  • URI GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 config_id 是 String 参数模板id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。 取值必须为数字,不能为负数。 limit 否 Integer 查询个数上限值。 取值范围: 1~100。 不传该参数时,默认查询前100条信息。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 datastores Array of 表4 objects 数据库接口信息。 表4 DataStoreList 参数 参数类型 描述 datastore_name String 数据库接口。 version String 数据库接口版本。 mode String 实例类型。 取值为“Cluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。 取值为“InfluxdbSingle”,表示GeminiDB Influx单节点实例类型。 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。
  • 响应示例 状态码: 200 Success { "datastores" : [ { "datastore_name" : "mongodb", "mode": "ReplicaSet", "version" : "4.0" }, { "datastore_name" : "influxdb", "mode": "InfluxdbCluster", "version" : "1.7" }, { "datastore_name" : "cassandra", "mode": "ReplicaCircle", "version" : "3.11" } ] }
  • 操作场景 您可以复制您创建的自定义数据库参数模板。当您已创建一个数据库参数模板,并且想在新的数据库参数模板中包含该组中的大部分自定义参数和值时,复制参数模板是一个方便的解决方案。您还可以导出某数据库实例应用的参数列表,生成一个新的参数模板,供您后期使用。 复制数据库参数模板之后,新参数模板可能不会立即显示,建议您等待5分钟再使用。 您无法复制默认参数模板。不过,您可以创建基于默认参数模板的新参数模板。
  • 操作场景 您可以复制您创建的自定义数据库参数模板。当您已创建一个数据库参数模板,并且想在新的数据库参数模板中包含该组中的大部分自定义参数和值时,复制参数模板是一个方便的解决方案。您还可以导出某数据库实例应用的参数列表,生成一个新的参数模板,供您后期使用。 复制数据库参数模板之后,新参数模板可能不会立即显示,建议您等待5分钟再使用。 您无法复制默认参数模板。不过,您可以创建基于默认参数模板的新参数模板。
  • 查看目标参数模板的参数修改历史 在“参数管理”页面的“自定义模板”页签,单击目标参数模板名称。 单击“参数修改历史”。 您可查看一定时间范围内(小于等于2年)的参数修改历史,默认查询7天内的参数修改历史。 您可查看参数对应的参数名称、修改前参数值、修改后参数值、修改状态和修改时间。 如果修改后参数模板未应用,请根据业务需要,参考应用 GaussDB (for MySQL)标准版参数模板,将其应用到对应实例。
  • URI GET /v3/{project_id}/configurations/{config_id}/apply-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 config_id 是 String 参数组ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询记录数。默认为10,不能为负数,最小值为1,最大值为100。 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。
  • 响应示例 状态码: 200 Success. { "total_count" : 1, "histories" : [ { "target_id" : "06789bdfbe414d78b9cef1b79d7d9680in07", "target_name" : "gauss-11", "apply_result" : "SUC CES S", "applied_at" : 1712246191000, "error_code" : "" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count String 应用记录数量。 histories Array of TemplateApplyHistory objects 应用记录信息 表5 TemplateApplyHistory 参数 参数类型 描述 target_id String 应用实例ID。 target_name String 应用实例名称。 apply_result String 应用结果。 applied_at Number 应用时间。 error_code String 错误码。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应示例 状态码: 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列的操作。" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 configurations ParameterConfigurationInfo object 参数解释: 实例参数组信息。 total_count Long 参数解释: 实例参数总数。 取值范围: ≥0 parameter_values Array of ParameterValuesInfo objects 参数解释: 实例参数信息。 表5 ParameterConfigurationInfo 参数 参数类型 描述 datastore_version_name String 参数解释: 数据库版本名称。 取值范围: 2.0 datastore_name String 参数解释: 参数组引擎名称。 取值范围: taurus created String 参数解释: 参数组创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 updated String 参数解释: 参数组更新时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 表6 ParameterValuesInfo 参数 参数类型 描述 name String 参数解释: 参数名称。 取值范围: 不涉及。 value String 参数解释: 参数值。 取值范围: 不涉及。 restart_required Boolean 参数解释: 是否需要重启。 取值范围: false:否。 true:是。 readonly Boolean 参数解释: 是否只读。 取值范围: false:否。 true:是。 value_range String 参数解释: 参数值范围。 取值范围: 不涉及。 type String 参数解释: 参数类型。 取值范围: string integer boolean list float description String 参数解释: 参数描述。 取值范围: 不涉及。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 X-Language 否 String 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: en-us zh-cn 默认值: en-us。
  • URI GET /v3/{project_id}/instances/{instance_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 instance_id 是 String 参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为整数,不能为负数。 取值范围: ≥0 默认取值: 0 limit 否 Integer 参数解释: 查询记录数。 约束限制: 必须为整数,不能为负数。 取值范围: 1-100 默认取值: 100
  • 参数模板类型 创建数据库实例时可以指定数据库参数模板为默认参数模板或已有参数模板。实例创建成功后也可以变更实例关联的参数模板。 默认参数模板 默认组包含针对运行的数据库实例进行优化的引擎默认值和数据库服务系统默认值。 自定义参数模板 如果希望数据库实例以客户自定义的引擎配置值运行,可轻松地创建一个新数据库参数模板,修改所需参数并应用到数据库实例,用以使用新数据库参数模板。 数据库参数模板与实例建立关联后,如果修改了参数模板中的参数,那么使用该参数模板的所有实例,都将获得该参数模板中对应参数的更新。
  • 参数模板注意事项 系统提供的默认参数模板不允许修改,只可单击参数模板名称进行查看。如果出现参数设置不合理导致数据库无法启动,可参考默认参数模板重新配置。 对于某些运行参数修改,您需在实例列表中,查看实例状态,如果显示“参数模板变更,等待重启”,则需重启关联的实例使之生效。 在数据库参数模板内设置参数不恰当可能会产生意外的不利影响,包括性能降低和系统不稳定。修改数据库参数时应始终保持谨慎,且修改数据库参数模板前要备份数据。将参数模板更改应用于生产数据库实例前,您应当在测试数据库实例上试用这些参数模板设置更改。