华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 default_topic_urn String 默认消息通知主题的唯一资源标识符 topic_count Integer 已确认的消息通知主题数量 topics Array of TopicBean objects 已确认的消息通知主题列表 表4 TopicBean 参数 参数类型 描述 name String 消息通知主题名称 topic_urn String 消息通知主题的唯一资源标识符 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码： 200 请求成功 { "file_list" : [ { "id" : "xxxxxxxxxxxx", "name" : "xxxx", "path" : "xxxxxxxxxxxx", "risk_level" : 2, "type" : "BUCKET" } ], "current_page" : 0, "total" : 1 } 状态码： 400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

URI GET /v1/{project_id}/sdg/server/relation/jobs/{job_id}/obs/{bucket_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID job_id 是 String 任务ID bucket_id 是 String 桶ID 表2 Query参数 参数 是否必选 参数类型 描述 assets_name 否 String 资产名称 risk_start 是 Integer 起始风险等级 risk_end 是 Integer 终止风险等级 offset 是 Integer 偏移量 size 是 Integer 页面大小 limit 否 Integer 分页大小

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer 关系信息总数 current_page Integer 当前页 file_list Array of RelationSimpleInfo objects 关系信息列表 表4 RelationSimpleInfo 参数 参数类型 描述 id String 关系信息ID name String 关系信息名称 path String 关系信息路径 risk_level Integer 风险等级 type String 关系信息类型 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 region_id String 当前项目所在region的id，如：xx-xx-1。 watermarked_file String 添加水印后的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.doc，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.doc为对象全路径名。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

请求示例 给obs://hwbucket/hwinfo/hw.doc路径下的WORD文档嵌入blind_watermark的明水印和visible_watermark的暗水印。 POST /v1/{project_id}/doc-address/watermark/embed { "region_id" : "xx-xx-1", "src_file" : "obs://hwbucket/hwinfo/hw.doc", "doc_type" : "WORD", "blind_watermark" : "blind_watermark", "visible_watermark" : "visible_watermark" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 项目所在region的id，如：xx-xx-1。 src_file 是 String 待添加水印的文档地址，当前只支持OBS对象，格式为 obs://bucket/object ，其中bucket为和当前项目处于同一区域的OBS桶名称，object为对象全路径名。例如：obs://hwbucket/hwinfo/hw.png，其中obs://表示OBS存储，hwbucket为桶名，hwinfo/hw.png为对象全路径名。 doc_type 是 String 待嵌入水印的文档类型。 枚举值： WORD EXCEL PDF PPT dst_file 否 String 添加水印后的文档存放地址，格式和要求同src_file字段，不设置时，默认取src_file的值，即添加水印后覆盖原文件。 blind_watermark 否 String 暗文字水印内容，与“visible_watermark”字段至少有一个不为空 visible_watermark 否 String 明文字水印内容，与暗水印“blind_watermark”字段至少有一个不为空。 image_mark 否 String 待嵌入的图形明水印文件的地址, 字段格式要求同src_file字段，图形文件的格式必须为“png”或“jpg”，否则返回参数错误；图像文件大小不超过1MB visible_type 否 String 该字段控制明水印嵌入文字还是图片。默认为TEXT类型，需填写visible_watermark字段设置明文字水印； 当该字段为IMAGE时，需填写image_watermark字段设置水印图片地址此时 ，“visible_watermark”，“font_size”，“rotation”和“opacity”字段无效。 枚举值： TEXT IMAGE file_password 否 String 待加水印文件有密码时，读取文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。 marked_file_password 否 String 添加水印后给文件设置密码， 最大支持长度256。默认不加文档密码。 readonly_password 否 String 添加水印后给文件设置只读密码， 最大支持长度256。默认不加只读密码。 front 否 Integer 明水印字体大小，取值为[1,100]，默认值50 rotation 否 Integer 明水印旋转角度，逆时针方向，取值为[0,90]，默认值45。 opacity 否 Float 明水印的透明度，取值[0,1]，默认值为0.3；

请求示例 脱敏策略列表中对字段col使用KEYWORD脱敏算法，将指定关键字keyword替换为target。 POST https://{endpoint}/v1/{project_id}/data/mask { "mask_strategies" : { "name" : "col", "algorithm" : "KEYWORD", "parameters" : { "key" : "keyword", "target" : "target" } }, "data" : { "col" : "keyword" } }

请求示例 修改xxxxxxxxxxxxxxxxxxx为通知主题，项目ID为xxxxxxxxxxxxxxxxxxx，告警通知状态为开启。 PUT /v1/{project_id}/sdg/smn/topic { "id" : "xxxxxxxxxxxxxxxxxxx", "project_id" : "xxxxxxxxxxxxxxxxxxx", "status" : 1, "topic_urn" : "xxxxxxxxxxxxxxxxxxx" }

请求示例 提取数据水印，水印密钥是key，字段类型列表中数据的字段名称为col，该字段为非主键。 POST https://{endpoint}/v1/{project_id}/sdg/database/watermark/extract { "watermark_key" : "key", "columns" : { "name" : "col", "type" : "INTEGER", "primary_key" : false }, "data" : { "col" : 0.1 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer 关系信息总数 bucket_list Array of RelationSimpleInfo objects 关系信息列表 表4 RelationSimpleInfo 参数 参数类型 描述 id String 关系信息ID name String 关系信息名称 path String 关系信息路径 risk_level Integer 风险等级 type String 关系信息类型 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码： 200 请求成功 { "bucket_list" : [ { "id" : "xxxxxxxxxxxx", "name" : "xxxx", "path" : "xxxxxxxxxxxx", "risk_level" : 2, "type" : "BUCKET" } ], "total" : 1 } 状态码： 400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }

URI GET /v1/{project_id}/sdg/server/relation/jobs/{job_id}/obs/buckets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID job_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型 描述 assets_name 否 String 资产名称 risk_start 是 Integer 起始风险等级 risk_end 是 Integer 终止风险等级 offset 否 Integer 页码 limit 否 Integer 分页大小

URI URI格式 GET https://{Endpoint}/v3/{project_id}/datastore/versions URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/datastore/versions 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/recycle-policy URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/recycle-policy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 datastores Array of objects 数据库引擎列表。 详情请参见表3。 表3 dataStores字段数据结构说明 参数 参数类型 描述 supported_versions Array of strings 部署形态支持的引擎版本列表。 instance_mode String 部署形态。 枚举值： ha：主备版 independent：独立部署 正常响应样例 { "datastores": [ { "instance_mode": "ha", "supported_versions": [ "2.0", "2.3", "2.6", "2.9" ] } ] }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/password 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。

响应消息示例 正常响应要素说明 { "created": "2022-04-11 10:46:59", "updated": "2022-04-11 10:46:59", "datastore_version": "2.0", "datastore_name": "GaussDB", "configuration_parameters": [ { "name": "audit_system_object", "value": "12295", "type": "integer", "description": "Determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include databases, users, schemas, and tables. You can change the parameter value to audit only the operations on required database objects. During a forcible primary/standby failover, set audit_system_object to the maximum value and audit all DDL objects. If the parameter value is incorrectly changed, DDL audit logs will be lost. Contact customer service personnel to change it.", "restart_required": false, "value_range": "0-2097151" } ] }

URI URI格式 POST https://{Endpoint}/v3/{project_id}/configurations/{config_id}/reset URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/reset 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 config_id String 是 参数模板ID。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restart URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/restart 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 String 实例ID。

请求示例 修改企业项目配额，实例的配额设置为1000个，cpu配额100000核数，内存配额200000GB，存储空间配额1000000GB。 { "eps_quotas": [ { "enterprise_projects_id": "0", "instance_quota": 1000, "vcpus_quota": 100000, "ram_quota": 200000, "volume_quota": 1000000 } ] }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl-cert/download-link URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/ssl-cert/download-link 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 String 实例ID。

响应消息 正常响应要素说明 表4 参数说明 参数 参数类型 描述 id String 参数模板ID。 name String 参数模板名称。 created_at String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 正常响应样例 { "id" : "137eeaf0cc884ca4adffa9ebd101c115pr14", "name" : "paramTemplate-del", "created_at" : "2022-08-09T03:06:52+0800" }

请求示例 创建一个2.3版本，主备版部署形态的参数模板。 { "name": "paramTemplate", "description": "", "parameter_values": { "audit_system_object": "12294" }, "datastore": { "engine_version": "2.3", "instance_mode": "ha" } }

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 config_id 是 String 参数模板ID。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/volume-usage URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/volume-usage 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups/e28d08754b1a490fb2b3540ed013a7fbbr14 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 backup_id 是 String 备份ID。

请求示例 修改实例的参数failed_login_attempts的值为4。不需要重启。 { "values": { "failed_login_attempts": "4" } } 修改实例的参数track_activity_query_size的值为2048，修改参数max_replication_slots的值为25。需要重启。 { "values": { "track_activity_query_size": "2048", "max_replication_slots": "30" } }

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balance URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instance/dsfae23fsfdsae3435in14/balance 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。