华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 templates Array of ListAppTemplatesResult objects 函数应用程序模板列表 next_marker Long 下次读取位置 count Long 应用程序模板总数 表5 ListAppTemplatesResult 参数 参数类型 描述 id String 模板id name String 模板名称 runtime String 模板执行运行时 category String 模板使用场景 description String 模板描述 image String 模板镜像文件（base64编码） 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

URI GET /v2/{project_id}/fgs/application/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目 ID，获取方式请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 本次查询起始位置，默认值0 缺省值：0 最小长度：0 最大长度：64 maxitems 否 String 本次查询最大返回的数据条数，最大值500，默认值100 缺省值：0 最小长度：0 最大长度：64 runtime 否 String 模板执行运行时 缺省值：all category 否 String 模板类别 缺省值：all

响应参数 状态码： 202 表4 响应Header参数 参数 参数类型 描述 Content-Type String application/json 表5 响应Body参数 参数 参数类型 描述 instance_id String 预留实例id 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 application_id String 应用id 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

请求示例 创建函数应用程序。 POST /v2/{project_id}/fgs/applications { "name" : "appTest", "template_id" : "xxx", "params" : { }, "description" : "应用程序测试", "enterprise_project_id" : "0", "agency_name" : "" }

响应示例 状态码： 200 list applications successfully { "applications" : [ { "id" : "a2685d64-9bf6-481d-8845-0482271f99cc", "name" : "testApplication", "status" : "repoFail", "last_modified_time" : 1699320954910, "description" : "test function application" } ], "next_marker" : 1, "count" : 1 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 applications Array of ListFunctionApplicationResult objects 函数应用列表 next_marker Long 下次读取位置 count Long 应用程序总数 表4 ListFunctionApplicationResult 参数 参数类型 描述 id String 应用id name String 应用名称 status String 应用状态 last_modified_time Long 最后修改时间 description String 应用描述 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码： 200 get application successfully { "name" : "testApplication", "last_modified_time" : 1699356705515, "stack_resources" : null, "status" : "repoFail", "stack_name" : "", "repo_name" : "", "description" : "test for function application.", "repo" : { }, "project_id" : "c53626012ba84727b938ca8bf03108ef" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 name String 应用名称 last_modified_time Long 最后修改时间 stack_resources StackResource object 资源栈 status String 应用状态 stack_name String 资源栈名称 stack_id String 资源栈id repo_name String 存储库名称 description String 应用描述 repo RepoInfo object 存储库信息 pipeline_id String 管道id project_id String 项目id apig_url String 调用URL 表4 StackResource 参数 参数类型 描述 physical_resource_id String 物理资源id physical_resource_name String 物理资源名称 logical_resource_name String 逻辑资源名称 logical_resource_type String 逻辑资源类型 resource_status String 资源状态 status_message String 状态信息 href String 超链接地址 display_name String 云服务名称 表5 RepoInfo 参数 参数类型 描述 https_url String http地址 web_url String 存储库链接 repo_status String 存储库状态 error_msg String 报错信息 project_id String 项目id 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

结构化模板日志详情 NGINX日志示例 表1 结构化模板示例 模板名称 示例日志 NGINX 192.168.1.101 - [27/Aug/2018:14:20:29 +0800] "GET http://www.example.com / HTTP/1.0" 200 8796 6775 "-" "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36" "-" "0.185" "0.010" 12.129.120.121:8090 200 794 结构化字段及字段说明 表2 结构化字段 字段 示例 描述 类型 body_bytes_sent 6775 发送给客户端的文件主体内容的大小 long bytes_sent 8796 响应大小 long host www.example.com 请求域名 string http_referer - 来源页面链接 string http_user_agent Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.131 Safari/537.36 客户端浏览器信息 string http_x_forwarded_for - 客户端的真实ip string remote_addr 192.168.1.101 客户端地址 string remote_user - 远程客户端用户名称 string request_length 794 请求长度 long request_method GET 请求方法 string request_time 0.185 请求时间 float request_uri / 请求url string scheme http http或https string server_protocol HTTP/1.0 请求协议 string status 200 响应状态码 long time_local 27/Aug/2018:14:20:29 日期 string upstream_addr 12.129.120.121:8090 后端服务器地址 string upstream_response_time 0.010 后端服务器响应时间 float upstream_status 200 后端服务器响应状态 long

DDS错误日志结构化模板日志详情 DDS错误日志示例日志 表3 结构化模板示例 模板名称 示例日志 DDS错误日志 {"log_type": "error_log","severity": "Error","log_time": "2022-08-22T09:33:15.142+0000","raw_message": "E QUERY [ClusterDisasterBackupChangeJob] Get global setting disasterBackup failed.","instance_id": "5b67dc63ba824145aae1f12ff51e58b8in02","node_id": "686a791e690e4db3af591ec4b6f72916no02"} 结构化字段及字段说明 表4 结构化字段 字段 示例 描述 类型 log_type error_log 日志类型 string severity Error 日志级别 string log_time 2022-08-22T09:33:15.142+0000 日志产生时间 string raw_message E QUERY [ClusterDisasterBackupChangeJob] Get global setting disasterBackup failed. 日志内容 string instance_id 5b67dc63ba824145aae1f12ff51e58b8in02 实例Id string node_id 686a791e690e4db3af591ec4b6f72916no02 节点Id string

DDS审计日志结构化模板日志详情 DDS审计日志示例 表5 结构化模板示例 模板名称 示例日志 DDS审计日志 {"topic":"auditLog","instanceid":"9fbf813bc27e4a3ab54bddf783a4f774in01","nodeid":"bf4cb0413d0b4221be94b08471708586no01","db":"test","coll":"testCollection","optype":"update","time":"2022-08-05T08:24:15.536+0000","user_ip":"10.4.23.205","user_port":"47668","user":"rw_testuser","param":{"command":"update","ns":"test.testCollection","op":[{"q":{"vin":"LDP31B965NG036174"},"u":{"$set":{"timestamp":{"$numberLong":"1659687855535"},"deviceTime":{"$numberLong":"1659687855340"},"longitude":"119.35516805555555","latitude":"26.057936388888891","location":"119.35516805555555,26.057936388888891","height":"10.097286797128618","direction":"12","speed":14,"accuracy":"0","h3Address7":"8741b5300ffffff"}},"upsert":true}],"args":{"update":"testCollection","ordered":true,"$db":"test","$clusterTime":{"clusterTime":{"$timestamp":{"t":1659687855,"i":1685}},"signature":{"hash":{"$binary":"CP5bfEf+gBJZdAxCKtF9HiSeqQY=","$type":"00"},"keyId":{"$numberLong":"7102408879899674942"}}},"lsid":{"id":{"$binary":"PXVVrbuvRuGkypCbu/oXXQ==","$type":"04"}}}}} 结构化字段及字段说明 表6 结构化字段 字段 示例 描述 类型 topic auditLog 消息主题 string instanceid 9fbf813bc27e4a3ab54bddf783a4f774in01 实例ID string nodeid bf4cb0413d0b4221be94b08471708586no01 节点ID string db test 数据库名 string coll testCollection 开启分片的集合名 string optype update 操作类型 string time 2022-08-05T08:24:15.536+0000 审计日志时间 string user_ip 10.4.23.205 客户端IP string user_port 47668 客户端端口 string user rw_testuser 数据库用户账户 string param {\"command\":\"update\",\"ns\":\"test.testCollection\",\"op\":[{\"q\":{\"vin\":\"LDP31B965NG036174\"},\"u\":{\"$set\":{\"timestamp\":{\"$numberLong\":\"1659687855535\"},\"deviceTime\":{\"$numberLong\":\"1659687855340\"},\"longitude\":\"119.35516805555555\",\"latitude\":\"26.057936388888891\",\"location\":\"119.35516805555555,26.057936388888891\",\"height\":\"10.097286797128618\",\"direction\":\"12\",\"speed\":14,\"accuracy\":\"0\",\"h3Address7\":\"8741b5300ffffff\"}},\"upsert\":true}],\"args\":{\"update\":\"testCollection\",\"ordered\":true,\"$db\":\"test\",\"$clusterTime\":{\"clusterTime\":{\"$timestamp\":{\"t\":1659687855,\"i\":1685}},\"signature\":{\"hash\":{\"$binary\":\"CP5bfEf+gBJZdAxCKtF9HiSeqQY=\",\"$type\":\"00\"},\"keyId\":{\"$numberLong\":\"7102408879899674942\"}}},\"lsid\":{\"id\":{\"$binary\":\"PXVVrbuvRuGkypCbu/oXXQ==\",\"$type\":\"04\"}}}} 数据库操作详情和参数 string

DDS慢日志结构化模板日志详情 DDS慢日志示例日志 表1 结构化模板示例 模板名称 示例日志 DDS慢日志 {"log_type": "slow_log","log_time": "2022-08-20T10:04:03.204000Z","namespace": "data0820.table","database": "data0820","collection": "table","operate_type": "insert","docs_scanned": 0,"docs_returned": 0,"n_deleted": 0,"n_matched": 0,"n_modified": 0,"n_inserted": 10,"cost_time": 555,"lock_time": 0,"whole_message": "{\"op\": \"insert\", \"ns\": \"data0820.usrtable\", \"command\": \"{N}\", \"ninserted\": 1, \"keysInserted\": 1, \"numYield\": 0, \"locks\": {\"Global\": {\"acquireCount\": {\"r\": 5, \"w\": 5}}, \"Database\": {\"acquireCount\": {\"w\": 4, \"W\": 1}}, \"Collection\": {\"acquireCount\": {\"w\": 2}}, \"oplog\": {\"acquireCount\": {\"w\": 2}}}, \"responseLength\": 230, \"protocol\": \"op_msg\", \"millis\": 555, \"ts\": {\"$date\": 1660989843204}, \"client\": \"192.168.0.64\", \"appName\": \"MongoDB Shell\", \"allUsers\": [{\"user\": \"rwuser\", \"db\": \"admin\"}], \"user\": \"rwuser@admin\"}","instance_id": "5b67dc63ba824145aae1f12ff51e58b8in02","node_id": "686a791e690e4db3af591ec4b6f72916no02","client_ip": "190.12.11.11","username": "user中文","keys_examined": 0} 结构化字段及字段说明 表2 结构化字段 字段 示例 描述 类型 log_type slow_log 日志类型 string log_time 2022-08-20T10:04:03.204000Z 慢日志产生时间 string namespace data0820.table 命名空间 string database data0820 库名称 string collection table 表名称 string operate_type insert 操作类型 string docs_scanned 0 数据库扫描行数 long docs_returned 0 查询返回结果行数 long n_deleted 0 删除行数 long n_matched 0 更新匹配行数 long n_modified 0 实际更新行数 long n_inserted 10 插入行数 long cost_time 555 操作花费的时间 long lock_time 0 wait_lock的时间 long whole_message {\"op\": \"insert\", \"ns\": \"data0820.usrtable\", \"command\": \"{N}\", \"ninserted\": 1, \"keysInserted\": 1, \"numYield\": 0, \"locks\": {\"Global\": {\"acquireCount\": {\"r\": 5, \"w\": 5}}, \"Database\": {\"acquireCount\": {\"w\": 4, \"W\": 1}}, \"Collection\": {\"acquireCount\": {\"w\": 2}}, \"oplog\": {\"acquireCount\": {\"w\": 2}}}, \"responseLength\": 230, \"protocol\": \"op_msg\", \"millis\": 555, \"ts\": {\"$date\": 1660989843204}, \"client\": \"192.168.0.64\", \"appName\": \"MongoDB Shell\", \"allUsers\": [{\"user\": \"rwuser\", \"db\": \"admin\"}], \"user\": \"rwuser@admin\"} 原始日志信息 string instance_id 5b67dc63ba824145aae1f12ff51e58b8in02 实例ID string node_id 686a791e690e4db3af591ec4b6f72916no02 节点ID string

结构化模板日志详情 ER企业路由器日志示例 表1 结构化模板示例 模板名称 示例日志 ER企业路由器 1 0ebc7f641d80f4d32f9dc0056bdaae5b 740cc7e2-c686-496e-9fae-2dfc33e9d443 2756dc58-49be-413d-852f-accc5657a6c3 192.168.3.227 172.16.0.206 0 0 1 279 27342 1670338595 1670339195 egress 结构化字段及字段说明 表2 结构化字段 字段 示例 描述 类型 version 1 ER流日志版本 long project_id 0ebc7f641d80f4d32f9dc0056bdaae5b 项目ID string instance_id 740cc7e2-c686-496e-9fae-2dfc33e9d443 ER实例的ID string resource_id 2756dc58-49be-413d-852f-accc5657a6c3 流量所属连接的ID string srcaddr 192.168.3.227 源地址 string dstaddr 172.16.0.206 目的地址 string srcport 0 源端口 long dstport 0 目的端口 long protocol 1 IANA协议编号 关于协议的更多信息，请参见Internet协议编号 long packets 279 本段流日志捕获窗口时间周期内数据包的数量 long bytes 27342 本段流日志捕获窗口时间周期内数据包的大小 long start 1670338595 本段流日志捕获窗口启动的时间，采用Unix秒的格式 long end 1670339195 本段流日志捕获窗口结束的时间，采用Unix秒的格式 long direct egress 流量的方向： ingress：入方向，表示流量从外部进入ER连接内 egress：出方向，表示流量从ER连接发送出去 string

CFW访问控制日志结构化模板日志详情 CFW访问控制日志示例 表5 结构化模板示例 模板名称 示例日志 CFW访问控制日志 {"app":"PING","direction":"in2out","source-zone":"3002","rule_id":"56827792-173e-435a-b22b-229f21d78244","protocol":"ICMP: ECHO_REQUEST","dst_ip":"100.85.222.23","src_ip":"100.85.112.49","log_type":"eip","hit_time":1655882537006,"log-id":"44243649","dst_port":"45243","destination-zone":"3001","index_day":"2022.06.22","log_id":6781,"src_port":"17589","fw_instance_id":"58ead9e7-418d-4166-8df8-f24941d4205c","action":"permit","vsys":"1"} 结构化字段及字段说明 表6 结构化字段 字段 示例 描述 类型 app PING 应用类型 string direction in2out 流量方向 out2in：入方向 in2out：出方向 string source-zone 3002 资源区域 string rule_id 56827792-173e-435a-b22b-229f21d78244 触发规则的ID string protocol ICMP: ECHO_REQUEST 协议类型 string dst_ip 100.85.222.23 目的IP地址 string src_ip 100.85.112.49 源IP地址 string log_type eip 日志类型 string hit_time 1655882537006 访问发生的时间 long log-id 44243649 文档ID，第一页为空，其他页不为空 string dst_port 45243 目的端口号 string destination-zone 3001 目标区域 string index_day 2022.06.22 索引日期 string log_id 6781 文档ID，第一页为空，其他页不为空 long src_port 17589 源端口号 string fw_instance_id 58ead9e7-418d-4166-8df8-f24941d4205c 防火墙实例id string action permit 云防火墙当前的响应动作。 permit：放行 deny：阻断 string vsys 1 防火墙防护方向 string

CFW攻击日志结构化模板日志详情 CFW攻击日志示例日志 表3 结构化模板示例 模板名称 示例日志 CFW攻击日志 {"source":"0","app":"HTTP","direction":"out2in","dst_ip":"100.85.222.23","src_ip":"10.108.170.229","event_time":1655974411462,"log_type":"eip","dst_port":"80","attack_rule_id":"330409","index_day":"2022.06.23","log_id":462688,"src_port":"51002","protocol":"TCP","packet":"+hZUZMhT+hY/AaHMCABFAADnicBAAHgGgJIKbKrlZFXeF8c6AFAYCIpDV562+VAYBAILMwAAR0VUIC9qb2JtYW5hZ2VyL2xvZ3MvLi4lMjUyZi4uJTI1MmYuLiUyNTJmLi4lMjUyZi4uJTI1MmYuLiUyNTJmLi4lMjUyZi4uJTI1MmYuLiUyNTJmLi4lMjUyZi4uJTI1MmYuLiUyNTJmZXRjJTI1MmZwYXNzd2QgSFRUUC8xLjENCkhvc3Q6IDEwMC44NS4yMjIuMjMNClVzZXItQWdlbnQ6IGN1cmwvNy42NS4wDQpBY2NlcHQ6ICovKg0KDQo=","level":"HIGH","attack_type":"Vulnerability Exploit Attack","fw_instance_id":"58ead9e7-418d-4166-8df8-f24941d4205c","action":"permit","vsys":"1","attack_rule":"VMware Spring Cloud Directory Traversal Vulnerability (CVE-2020-5410)"} 结构化字段及字段说明 表4 结构化字段 字段 示例 描述 类型 source 0 检测到攻击的防御模式 0：基础防御 1：虚拟补丁 string app HTTP 应用类型 string direction out2in 流量方向 out2in：入方向 in2out：出方向 string dst_ip 100.85.222.23 目的IP地址 string src_ip 10.108.170.229 源IP地址 string event_time 1655974411462 检测到的攻击时间 long log_type eip 日志类型 string dst_port 80 目的端口号 string attack_rule_id 330409 检测到攻击的防御规则ID号 string index_day 2022.06.23 索引日期 string log_id 462688 文档ID,第一页为空，其他页不为空 long src_port 51002 源端口号 string protocol TCP 协议类型 string packet +hZUZMhT+hY/AaHMCABFAADnicBAAHgGgJIKbKrlZFXeF8c6AFAYCIpDV562+VAYBAILMwAAR0VUIC9qb2JtYW5hZ2VyL2xvZ3MvLi4lMjUyZi4uJTI1MmYuLiUyNTJmLi4lMjUyZi4uJTI1MmYuLiUyNTJmLi4lMjUyZi4uJTI1MmYuLiUyNTJmLi4lMjUyZi4uJTI1MmYuLiUyNTJmZXRjJTI1MmZwYXNzd2QgSFRUUC8xLjENCkhvc3Q6IDEwMC44NS4yMjIuMjMNClVzZXItQWdlbnQ6IGN1cmwvNy42NS4wDQpBY2NlcHQ6ICovKg0KDQo= 防护流量的报文数 string level HIGH 表示检测到威胁的等级。 CRITICAL：严重 HIGH：高 MIDDLE：中 LOW：低 string attack_type Vulnerability Exploit Attack 发生攻击的类型。 Vulnerability Exploit Attack：漏洞攻击 Vulnerability Scan：漏洞扫描 Trojan：木马病毒 Worm：蠕虫病毒 Phishing：网络钓鱼攻击 Web Attack：Web攻击 Application DDoS：DDoS攻击 Buffer Overflow：缓冲区溢出攻击 Password Attack：密码攻击 Mail：邮件相关类型的攻击行为 Access Control：访问控制行为 Hacking Tool：黑客工具 Hijacking：劫持行为 Protocol Exception：存在异常协议 Spam：存在垃圾邮件 Spyware：存在间谍软件 DDoS Flood：DDoS泛洪攻击 Suspicious DNS Activity：可疑DNS活动 Other Suspicious Behavior：其他可疑行为 string fw_instance_id 58ead9e7-418d-4166-8df8-f24941d4205c 防火墙实例id string action permit 云防火墙当前的响应动作。 permit：放行 deny：阻断 string vsys 1 防火墙防护方向 string attack_rule VMware Spring Cloud Directory Traversal Vulnerability (CVE-2020-5410) 检测到攻击的防御规则 string

CFW流量日志结构化模板日志详情 CFW流量日志示例日志 表1 结构化模板示例 模板名称 示例日志 CFW流量日志 {"dst_port":"80","app":"HTTP","to_c_pkts":0.1,"dst_ip":"100.85.222.23","to_c_bytes":0.1,"end_time":1655436321000,"src_ip":"10.108.170.229","index_day":"2022.06.17","bytes":1232.1,"log-id":"4424364f","vsys":"1","suffix":"67","packets":10.1,"direction":"out2in","protocol":"TCP","to_s_bytes":1232.1,"to_s_pkts":10.1,"src_port":"63934","start_time":1655436299000,"fw_instance_id":"efbeb90c-1108-42ce-b099-f7e035a10b67"} 结构化字段及字段说明 表2 结构化字段 字段 示例 描述 类型 dst_port 80 目的端口号 string app HTTP 应用类型 string to_c_pkts 0.1 服务端向客户端发送的报文数 float dst_ip 100.85.222.23 目的IP地址 string to_c_bytes 0.1 服务端向客户端发送的字节数 float end_time 1655436321000 流结束时间 long src_ip 10.108.170.229 源IP地址 string bytes 1232.1 防护流量的字节数 float log-id 4424364f 日志Id string vsys 1 防火墙防护方向 string suffix 67 后缀 string packets 10 防护流量的报文数 long direction out2in 流量方向 out2in：入方向 in2out：出方向 string protocol TCP 协议类型 string to_s_bytes 1232.1 客户端向服务端发送的字节数 float to_s_pkts 10.1 客户端向服务端发送的报文数 float src_port 63934 源端口号 string start_time 1655436299000 流开始时间 long fw_instance_id efbeb90c-1108-42ce-b099-f7e035a10b67 防火墙实例id string

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略对象，包括备份保留的天数和备份开始时间。 详情请参见表3。 reserve_backups 否 Boolean 仅关闭备份策略时有效，默认为true。 true：表示保留自动备份和差异备份。 false：表示关闭备份策略的同时，删除已有的自动备份和差异备份。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：0～732。取0值，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。 须知： 关闭备份策略后，备份任务将立即停止，所有增量备份任务将立即删除，使用增量备份的相关操作可能失败，相关操作不限于下载、复制、恢复、重建等，请谨慎操作。 start_time 否 String 备份时间段。自动备份将在该时间段内触发。除关闭自动备份策略外，必选。 取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00、15、30或45。 取值示例： 08:15-09:15 23:00-00:00 period 否 String 备份周期配置。自动备份将在每星期指定的天进行。除关闭自动备份策略外，必选。 取值范围：格式为逗号隔开的数字，数字代表星期。 取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。

请求示例 设置周一和周二19:00~20:00内进行自动备份，备份文件保留7天 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2" } } 关闭自动备份策略 { "backup_policy": { "keep_days": 0 }, "reserve_backups": false }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 backups Array of objects 备份列表。 详情请参见表3。 total_count Integer 总记录数。 表3 backups字段数据结构说明 名称 参数类型 说明 id String 备份ID。 name String 备份名字。 type String 备份类型，取值： “auto”: 自动全量备份 “manual”: 手动全量备份 “fragment”: 差异全量备份 “incremental”: 自动增量备份 size Long 备份大小，单位：KB status String 备份状态，取值： BUILDING: 备份中。 COMPLETED: 备份完成。 FAILED：备份失败。 DELETING：备份删除中。 begin_time String 备份开始时间。 全量备份类型下，指备份开始时间。 MySQL增量备份类型，指备份文件中上一轮增备任务的最后一个事务的提交时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 备份结束时间。 全量备份类型下，指备份结束时间。 MySQL增量备份类型，指备份文件中最后一个事务的提交时间。 格式为“yyyy-mm-ddThh:mm:ssZ”，其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 datastore Object 数据库版本信息。 详情请参见表4。 databases Array of objects 用户自建库，仅Microsoft SQL Server的局部备份。 详情请参见表5。 instance_id String 备份所在实例ID。 associated_with_ddm Boolean 是否已被DDM实例关联。 表4 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎，支持的引擎如下，不区分大小写： MySQL PostgreSQL SQLServer version String 数据库版本。 表5 databases字段数据结构说明 名称 参数类型 说明 name String 用户自建数据库名。 正常响应样例 RDS for MySQL实例： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.7" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } RDS for PostgreSQL实例： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br03", "name": "xxxx.xxx", "type": "incremental", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "9.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin03 ", "associated_with_ddm": false }], "total_count": 1 } RDS for SQL Server实例： { "backups": [{ "id ": "43e4feaab48f11e89039fa163ebaa7e4br04", "name": "xxxx.xxx", "type": "manual", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "SQLServer", "version": "2014_WEB" }, "databases": [{ "name": "user01" }, { "name": "user02" }], "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04", "associated_with_ddm": false }], "total_count": 1 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 backup_id 否 备份ID。 backup_type 否 备份类型，取值： “auto”: 自动全量备份 “manual”: 手动全量备份 “fragment”: 差异全量备份 “incremental”: 自动增量备份 offset 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 begin_time 否 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： “begin_time”有值时，“end_time”必选。 end_time 否 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： “end_time”有值时，“begin_time”必选。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4in01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库名称。 数据库名称长度可在1～64个字符之间，由字母、数字、中划线、下划线或英文句点组成，不能包含其他特殊字符，且不能以RDS for SQL Server系统库开头或结尾。 RDS for SQL Server系统库包括master，msdb，model，tempdb，resource以及rdsadmin。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 审计日志保存天数，取值范围0~732。 取值0，表示关闭审计日志策略。 取值1~732，表示开启审计日志策略，并设置审计日志保存天数为该值。 reserve_auditlogs 否 Boolean 仅关闭审计日志策略时有效。 true（默认），表示关闭审计日志策略的同时，延迟删除已有的历史审计日志。 false，表示关闭审计日志策略的同时，删除已有的历史审计日志。

请求示例 设置审计日志保存5天 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-policy { "keep_days":5 } 关闭审计日志策略，同时删除已有的历史审计日志 { "keep_days":0, "reserve_auditlogs":false }

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/restore-time?date=2020-12-26 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 date 否 所需查询的日期，为yyyy-mm-dd字符串格式，时区为UTC。

请求消息 请求参数 无。 URI样例 查询实例的所有可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore-time 根据指定日期查询实例的可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore-time?date=2020-12-26

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 restore_time Array of objects 可恢复时间段列表。 详情请参见表3。 表3 restore_time字段数据结构说明 名称 参数类型 说明 start_time Integer 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time Integer 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 正常响应样例 { "restore_time": [ { "start_time": 1532001446987, "end_time": 1532742139000 } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 instance_id String 实例ID。 dns_name String 实例域名。 dns_type String 实例域名类型：private ipv6_address String 实例域名绑定的vIP。 status String 域名状态。 正常响应样例 { "instance_id": "2de6315e7197418fbf2fdaed59d65da1in03", "dns_name": "2de6315e7197418fbf2fdaed59d65da1in03.ipv6.internal.***.mysql.rds-dev.myhuaweicloud.com", "dns_type": "private", "ipv6_address": "2001:db8:a583:3:2312:c71d:6e71:c952", "status": "normal" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 policy_para Array of objects 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见表3。 表3 policy_para字段数据结构说明 名称 参数类型 说明 backup_type String 指定备份的类型。取值如下： auto：自动全量备份。 incremental：自动增量备份。 manual：手动备份，仅RDS for SQL Server返回该备份类型 。 keep_days Integer 备份文件可以保存的天数。 destination_region String 设置跨区域备份策略的目标区域ID。 destination_project_id String 设置跨区域备份策略的目标project ID。 正常响应样例 备份策略关闭时： { "policy_para": { "keep_days": 0 } } RDS for MySQL、RDS for PostgreSQL自动备份策略和增量备份策略开启时： { "policy_para": [ { "keep_days": 7, "backup_type": "auto", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "incremental", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" } ] } RDS for SQL Server自动备份策略、增量备份策略和手动备份策略开启时： { "policy_para": [ { "keep_days": 7, "backup_type": "incremental", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "manual", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "auto", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" } ] } 异常响应 请参见异常请求结果。