云服务器内容精选

  • URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-upgrade/candidate-versions 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 instance_id 是 String 实例ID,严格匹配UUID规则。
  • 响应示例 实例在滚动升级中时,只返回滚动升级目标版本与滚动升级分片和AZ状态。 { "upgrade_type_list": [ { "upgrade_type": "grey", "upgrade_action_list": [ { "upgrade_action": "commit", "enable": false }, { "upgrade_action": "rollback", "enable": false }, { "upgrade_action": "upgrade", "enable": true }, { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null }, { "upgrade_type": "hotfix", "upgrade_action_list": null, "enable": false, "is_parallel_upgrade": null }, { "upgrade_type": "inplace", "upgrade_action_list": [ { "upgrade_action": "upgradeAutoCommit", "enable": true } ], "enable": true, "is_parallel_upgrade": null } ], "rollback_enabled": false, "source_version": "8.102.0", "target_version": null, "roll_upgrade_progress": { "not_fully_upgraded_az": "cn-southwest-244a,cn-southwest-244b,cn-southwest-244c", "already_upgraded_az": "", "az_description_map": { "cn-southwest-244c": "az3", "cn-southwest-244b": "az2", "cn-southwest-244a": "az1" } }, "upgrade_candidate_versions": [ "8.300.0", "8.103.0" ], "hotfix_upgrade_candidate_versions": [], "hotfix_rollback_candidate_versions": [], "hotfix_upgrade_infos": [], "hotfix_rollback_infos": [] }
  • 响应参数 表4 响应Body参数 参数 参数类型 描述 node_limit_sql_model_list Array of objects 限流SQL模板信息,详细内容请参见表5。 limit Integer 查询记录数。 offset Integer 索引位置。 total_count Integer 总数。 表5 ListNodeLimitSqlModelResponseResult 参数 参数类型 描述 sql_id String 限流任务的sql_id。 sql_model String 限流任务SQL模板。
  • 请求示例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/list-node-limit-sql-model?node_id=46d996fdda594f58b17fe509061e0893no14&offset=0
  • 响应示例 { "node_limit_sql_model_list" : [ { "sql_id" : "3519660378", "sql_model" : "select * from table where id= ?" } ], "total_count" : 1, "limit" : 10, "offset" : 1 }
  • URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/sync-limit-task 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 instance_id 是 String 实例ID。
  • restrict_nonsystem_relation_kind 参数说明:控制是否能访问用户创建的关系对象类型。 取值范围:字符串类型。 空表示不进行任何限制。 view表示禁用对用户创建的视图进行访问。 foreign-table表示禁用对用户创建的外表进行访问。 默认值:空。 设置方式:该参数属于USERSET类型参数,请参考表1中对应设置方法进行设置。 设置建议:设置为默认值。 在gs_dump执行导出的过程中,为防止恶意攻击,需要禁用访问用户创建的视图和外表,工具会将此参数的值会话级设置为'view, foreign-table',无需用户手动配置。
  • enable_rls_match_index 参数说明:控制是否支持在行级访问控制特性使用场景中,基于目标谓词条件对基表执行索引扫描。目标场景为:基表设置并开启了RLS(Row Level Security)策略,查询谓词中包含unleakproof类型系统函数或like操作符。 参数类型:布尔型 参数单位:无 取值范围: on:支持目标场景下的基表索引扫描。 off:不支持目标场景下的基表索引扫描。 默认值:off 设置方式:该参数属于SIGHUP类型参数,请参见表1中对应设置方法进行设置。 设置建议:推荐使用默认值。若业务热点查询语句为目标场景,且基表行级访问策略数量较少,可打开该开关以显著提升查询性能。 设置不当的风险与影响:此参数设置为on,在位图扫描算子切换为lossy模式且RLS策略数目较多时,会导致过滤谓词重复执行,影响性能。 该参数的修改,会影响目标场景下执行计划的生成,可通过重连、创建操作符等方式手动使缓存计划失效。 该参数开启后,会影响到位图扫描算子的生成,RLS策略谓词将被插入到Recheck过滤条件中;因此,在该算子切换为lossy模式且RLS策略数目较多时,会对性能产生一定影响。
  • use_elastic_search 参数说明:统一审计发送日志至Elastic Search系统,enable_security_policy打开且本参数打开后,统一审计日志会通过http(https)传递至Elastic Search系统(默认使用https安全协议)。 参数类型:布尔型 参数单位:无 取值范围: on:开启统一审计日志发送至Elastic Search。 off:关闭统一审计日志发送至Elastic Search。 默认值:off 设置方式:该参数属于POSTMASTER类型参数,请参考表1中对应设置方法进行设置。 设置建议:推荐使用默认值,需要将统一审计日志发送至Elastic Search系统时开启。 设置不当的风险与影响:此参数打开后需要保证elastic_search_ip_addr对应的es服务可正常连通,否则进程启动失败。
  • elastic_search_ip_addr 参数说明:Elastic Search系统IP地址,使用https协议格式为:https://ip:port:username;使用http协议格式为:http://ip:port。其中,ip为Elastic Search服务器的IP,port为Elastic Search HTTP通信的侦听端口,范围为9200 - 9299,username为用户在Elastic Search注册账号所使用的用户名,初始用户为elastic。使用https协议需要配置相关证书,详见《安全加固指南》中“统一审计“章节。 参数类型:字符串 参数单位:无 取值范围:合法IP字符串或空字符串。 默认值:"" 设置方式:该参数属于POSTMASTER类型参数,请参考表1中对应设置方法进行设置。 设置建议:推荐使用默认值,需要将统一审计日志发送至Elastic Search系统时且use_elastic_search为on时设置。 设置不当的风险与影响:需要保证该参数取值对应的es服务可正常连通,否则进程启动会失败。
  • tde_index_default_encrypt 参数说明:创建索引时,如果开启本参数,并且索引的基表是加密表,则数据库会自动将索引设置为加密索引,并自动为索引复制基表的加密算法、密钥等加密参数,对索引中的数据先加密再存储。 参数类型:布尔型 参数单位:无 取值范围: on:自动对加密表的索引设置加密参数。 off:不自动对加密表的索引设置加密参数。 默认值:off 设置方式:该参数属于SIGHUP类型参数,请参考表1中对应设置方法进行设置。 设置建议:如果所有加密表的索引都需要被加密,可开启该参数,无需手动将索引设置为加密索引。 设置不当的风险与影响:如果将参数设置为on,在加密表上创建的索引将被自动加密,影响查询索引的性能。
  • block_encryption_mode 参数说明:aes_encrypt和aes_decrypt函数进行加解密时使用的块加密模式。 参数类型:枚举类型 参数单位:无 取值范围:有效值有aes-128-cbc、aes-192-cbc、aes-256-cbc、aes-128-cfb1、aes-192-cfb1、aes-256-cfb1、aes-128-cfb8、aes-192-cfb8、aes-256-cfb8、aes-128-cfb128、aes-192-cfb128、aes-256-cfb128、aes-128-ofb、aes-192-ofb、aes-256-ofb。其中aes表示加/解密算法,128/192/256表示密钥长度(单位:bit),cbc/cfb1/cfb8/cfb128/ofb表示块加/解密模式。 默认值:aes-128-cbc 设置方式:该参数属于USERSET类型参数,请参考表1中对应设置方法进行设置。 设置建议:推荐使用默认值,可以根据实际业务需要进行调整。 设置不当的风险与影响:影响aes_encrypt和aes_decrypt函数的使用。
  • enable_mac_check 参数说明:表示基于标签的强制访问控制是否生效。 参数类型:布尔型 参数单位:无 取值范围: on:表示基于标签的强制访问控制生效。 off:表示基于标签的强制访问控制不生效。 默认值:off 设置方式:该参数属于SIGHUP类型参数,请参考表1中对应设置方法进行设置。 设置建议:推荐使用默认值,可以根据实际业务需要进行调整。 设置不当的风险与影响:请在充分理解参数含义,并经过测试验证后进行修改,避免出现意料之外的结果。
  • Schema GaussDB 的Schema如表1所示。 数据库禁止在提供功能接口的Schema下创建用户的业务数据,包括但不限于表、函数等(dbe_*, pkg_*)。 表1 GaussDB支持的Schema Schema名称 描述 dbe_perf DBE_PERF Schema内视图主要用来诊断性能问题,也是WDR Snapshot的数据来源。数据库安装后,默认只有初始用户和监控管理员具有模式dbe_perf的权限,有权查看该模式下的视图和函数。 snapshot 用于管理WDR snapshot的相关的数据信息,默认初始化用户或监控管理员用户可以访问。 sqladvsior 用于分布列推荐,具体使用方法见分布列推荐函数。 sys 用于提供系统信息视图接口。 pg_catalog 用于维护系统的catalog信息,包含系统表和所有内置数据类型、函数、操作符。 pg_toast 用于存储大对象(系统内部使用)。 public 公共模式,用于存储公共对象。search_path参数缺省时,如果存在用户同名的模式则将创建的表(以及其他对象)默认创建到同名模式下,不存在用户同名模式则自动放入public模式。 pkg_service 用于管理package服务相关信息。 pkg_util 用于管理package工具相关信息。 dbe_raw 高级功能包dbe_raw,用于raw类型数据的转化、取子串、求长度等操作。 dbe_session 高级功能包dbe_session,用于设置指定属性的值,并支持用户查询校验。 dbe_lob 高级功能包dbe_lob,用于大文件(clob/blob)的读取、写入、复制等操作。 dbe_match 高级功能包dbe_match,用于字符串相似度比较。 dbe_task 高级功能包dbe_task,用于作业任务的调度包括提交任务、取消任务、同步任务状态、更新任务信息等可以使数据库定期执行特定的任务。 dbe_sql 高级功能包dbe_sql,用于执行动态sql,可以在应用的运行时间构建查询和其它的命令。 dbe_file 高级功能包dbe_file,用于数据库外部文件的读取、复制、写入、删除、重命名等。 dbe_output 高级功能包dbe_output,用于打印输出信息。 dbe_random 高级功能包dbe_random,用于生成随机种子和随机数。 dbe_application_info 高级功能包dbe_application_info,用于记录客户端信息。 dbe_utility 高级功能包dbe_utility,用于存储过程调用调试工具,例如打印错误堆栈等。 dbe_scheduler 高级功能包dbe_scheduler,用于创建定时任务,通过程序(program)、调度(schedule)使数据库定期执行特定的任务。也可以通过授权、提供证书执行数据库外部任务。 information_schema 用于存储有关当前数据库中定义的对象的信息。 dbe_sql_util SQL运维功能,目前包含SQL Patch的运维接口。 dbe_xmlgen 高级功能包dbe_xmlgen,用于将查询结果转换成xml字符串。 dbe_describe 高级功能包dbe_describe,用于查询存储过程或函数的参数信息。 表2 GaussDB目前禁用的Schema Schema名称 描述 dbe_pldebugger 用于调试PL/SQL函数及存储过程,目前暂不支持,该视图下接口调用报错unsupported。 db4ai 用于管理AI训练中不同版本的数据信息。 Information Schema DBE_PERF Schema WDR Snapshot Schema DBE_SQL_UTIL Schema DBE_PLDEBUGGER Schema DBE_PLDEVELOPER
  • 示例 修改模式名称。 --将模式test_schema1重命名为test_sch1。 gaussdb=# ALTER SCHEMA test_schema1 RENAME TO test_sch1; --查询模式信息。 gaussdb=# \dn+ test* List of schemas Name | Owner | Access privileges | Description | WithBlockChain -----------+-------+-------------------+-------------+---------------- test_sch1 | omm | | | t (1 row) 修改模式所有者。 --创建用户test_user。 gaussdb=# CREATE ROLE test_user PASSWORD '********'; --将模式test_sch1的所有者修改为test_user。 gaussdb=# ALTER SCHEMA test_sch1 OWNER TO test_user; --查询模式信息。 gaussdb=# \dn+ test_sch1; List of schemas Name | Owner | Access privileges | Description | WithBlockChain -----------+-----------+-------------------+-------------+---------------- test_sch1 | test_user | | | t (1 row) --删除。 gaussdb=# DROP SCHEMA test_sch1; gaussdb=# DROP ROLE test_user; 修改默认字符集和字符序。 仅在MYSQL模式数据库下(即sql_compatibility = 'MYSQL')支持该语法。 除binary字符集和字符序外,当前仅支持指定与数据库编码相同的字符集。 --创建并切换至测试数据库。 gaussdb=# CREATE DATABASE test1 WITH DBCOMPATIBILITY = 'MYSQL' ENCODING = 'UTF8' LC_COLLATE = 'zh_CN.utf8' LC_CTYPE = 'zh_CN.utf8'; gaussdb=# \c test1 --创建模式test_sch2。 test1=# CREATE SCHEMA test_sch2; --修改其默认字符为utf8mb4,默认字符序修改为utf8mb4_bin。 test1=# ALTER SCHEMA test_sch2 CHARACTER SET utf8mb4 COLLATE utf8mb4_bin; --删除。 test1=# DROP SCHEMA test_sch2; --切换至默认数据库。(根据实际情况修改数据库名) test1=# \c postgres gaussdb=# DROP DATABASE test1;