华为云用户手册

安全认证配置 为了保证用户体验，同时为了防止账户被人通过暴力破解， GaussDB 设置了账户登录重试次数及失败后自动解锁时间的保护措施，GaussDB针对账户提供了以下能力： failed_login_attempts：允许用户设置最大登录失败次数。 password_lock_time：此参数允许用户修改账户被锁定后自动解锁时间，单位为天。 若管理员发现某账户被盗、非法访问等异常情况，可手动锁定该账户。当管理员认为账户恢复正常后，可手动解锁该账户。 以手动锁定和解锁用户joe为例，命令格式如下： 手动锁定 12 gaussdb=# ALTER USER joe ACCOUNT LOCK;ALTER ROLE 手动解锁 12 gaussdb=# ALTER USER joe ACCOUNT UNLOCK;ALTER ROLE

备份管理 GaussDB支持数据库实例的备份和恢复，以保证数据可靠性。备份目前将以未加密的方式存储，防止客户误操作或者服务异常的情况下，因没有开启备份而造成数据丢失的情况，GaussDB针对备份提供了以下能力： 提供了自动和手动的备份功能，具体内容请参见备份概述，在创建GaussDB实例时，系统默认开启实例级自动备份策略。实例创建成功后，您可根据业务需要修改实例级自动备份策略。 提供了自动备份策略，定时定期对数据库进行备份。具体内容请参见设置自动备份策略。 提供了导出备份文件的能力，具体内容请参见导出备份信息。

响应参数 表2 响应参数 参数 参数类型 描述 quotas quotas object 配额详情。详情请见表 quotas字段数据结构说明。 表3 quotas字段数据结构说明 参数 参数类型 描述 resources Array of resources objects 配额资源列表。详情请见表 resources字段数据结构说明。 表4 resources字段数据结构说明 参数 参数类型 描述 type String 查询配额的类型。 scaling_Policy为伸缩策略资源。 scaling_Instance为伸缩实例资源。 used Integer 已使用的配额数量 quota Integer 配额总数量 max Integer 配额上限 min Integer 配额下限

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

响应示例 { "quotas": { "resources": [ { "type": "scaling_Policy", "used": 2, "quota": 50, "max": 50, "min": 0 }, { "type": "scaling_Instance", "used": 0, "quota": 200, "max": 1000, "min": 0 } ] }}

返回值 正常 204 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

URI DELETE /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id}/{topic_urn} 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID scaling_group_id 是 String 伸缩组ID topic_urn 是 String SMN 服务中Topic的唯一的资源标识。

请求示例 删除ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组内topic_urn为urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh的通知。 DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_notification/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh

响应示例 { "limit": 20, "scaling_policy_execute_log": [ { "id": "b86e4175-30cb-4b1e-a332-83f9ee472c58", "status": "SUC CES S", "type": "REMOVE", "tenant_id": "0428982a1b8039f42f01c005edde7c0d", "scaling_resource_type": "SCALING_GROUP", "scaling_resource_id": "1f2d3e73-7ef6-40b3-a8fa-514b68eccaa7", "scaling_policy_id": "05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6", "old_value": "1", "desire_value": "0", "limit_value": "0", "execute_time": "2019-03-18T16:00:00Z", "execute_type": "RECURRENCE", "job_records": [ { "message": "modify desire number of scaling group", "job_name": "ADJUST_VM_NUMBERS", "record_type": "MEG", "record_time": "2019-03-18T16:00:00Z", "job_status": "SUCCESS" } ] } ], "total_number": 1, "start_number": 0}

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数 start_number Integer 查询的起始行号 limit Integer 查询记录数 scaling_policy_execute_log Array of scaling_policy_execute_log objects 伸缩策略执行日志列表。详情请见表 scaling_policy_execute_log字段数据结构说明。 表3 scaling_policy_execute_log字段数据结构说明 参数 参数类型 描述 status String 策略执行状态： SUCCESS：成功 FAIL：失败 EXECUTING：执行中 failed_reason String 策略执行失败原因 execute_type String 策略执行类型： SCHEDULE：自动触发（定时） RECURRENCE：自动触发（周期） ALARM：自动触发（告警） MANUAL：手动触发 execute_time String 策略执行时间，遵循UTC时间。 id String 策略执行日志ID tenant_id String 项目ID scaling_policy_id String 伸缩策略ID scaling_resource_type String 伸缩资源类型 伸缩组：SCALING_GROUP 带宽：BANDW IDT H scaling_resource_id String 伸缩资源ID old_value String 伸缩原始值 desire_value String 伸缩目标值 limit_value String 操作限制 当scaling_resource_type为BANDWIDTH时，且operation不为SET时，limit_value生效，单位为Mbit/s。 此时， 当operation为ADD时，limit_value表示最高带宽限制； 当operation为REDUCE时，limit_value表示最低带宽限制。 type String 策略执行任务类型 ADD：增加 REMOVE：减少 SET：设置为 job_records Array of job_records objects 策略执行动作包含的具体任务。详情请见表 job_records字段数据结构说明。 meta_data meta_data object 附加信息。详情请见表 meta_data字段数据结构说明。 表4 job_records字段数据结构说明 参数 参数类型 描述 job_name String 任务名称 record_type String 记录类型 API：接口调用类型 MEG：消息类型 record_time String 记录时间 request String 请求体，仅当record_type为API时有效 response String 返回体，仅当record_type为API时有效 code String 返回码，仅当record_type为API时有效 message String 消息，仅当record_type为MEG时有效 job_status String job执行状态： SUCCESS：成功 FAIL：失败 表5 meta_data字段数据结构说明 参数 参数类型 描述 metadata_bandwidth_share_type String 伸缩带宽策略中带宽对应的共享类型。 metadata_eip_id String 伸缩带宽策略中带宽对应的EIP的ID。 metadataeip_address String 伸缩带宽策略中带宽对应的EIP地址。

URI GET /autoscaling-api/v1/{project_id}/scaling_policy_execute_log/{scaling_policy_id} 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤，请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_policy_id 是 String 伸缩策略ID log_id 否 String 策略执行日志ID scaling_resource_type 否 String 伸缩资源类型 伸缩组：SCALING_GROUP 带宽：BANDWIDTH scaling_resource_id 否 String 伸缩资源ID execute_type 否 String 策略执行类型： SCHEDULED：自动触发（定时） RECURRENCE：自动触发（周期） ALARM：自动触发（告警） MANUAL：手动触发 start_time 否 String 查询的起始时间，遵循UTC时间，格式是“yyyy-MM-ddThh:mm:ssZ”。 end_time 否 String 查询的截止时间，遵循UTC时间，格式是“yyyy-MM-ddThh:mm:ssZ”。 start_number 否 Integer 查询的起始行号，默认为0。最小值为0。 limit 否 Integer 查询的记录条数，默认为20。取值范围为：0~100。

响应参数 表2 响应参数 参数 参数类型 描述 quotas quotas object 配额详情。详情请见表 quotas字段数据结构说明。 表3 quotas字段数据结构说明 参数 参数类型 描述 resources Array of resources objects 配额资源列表。详情请见表 resources字段数据结构说明。 表4 resources字段数据结构说明 参数 参数类型 描述 type String 查询配额的类型。 scaling_Group：伸缩组配额。 scaling_Config：伸缩配置配额。 scaling_Policy：伸缩策略配额。 scaling_Instance：伸缩实例配额。 bandwidth_scaling_policy：伸缩带宽策略配额。 used Integer 已使用的配额数量。 当type为scaling_Policy和scaling_Instance时，该字段为保留字段，返回-1。可通过查询弹性伸缩策略和伸缩实例配额查询指定弹性伸缩组下的弹性伸缩策略和伸缩实例已使用的配额数量。 quota Integer 配额总数量 max Integer 配额上限 min Integer 配额下限

响应示例 { "quotas": { "resources": [ { "type": "scaling_Group", "used": 2, "quota": 25, "max": 50, "min": 0 }, { "type": "scaling_Config", "used": 3, "quota": 100, "max": 200, "min": 0 }, { "type": "scaling_Policy", "used": -1, "quota": 50, "max": 50, "min": 0 }, { "type": "scaling_Instance", "used": -1, "quota": 200, "max": 1000, "min": 0 }, { "type": "bandwidth_scaling_policy", "used": 1, "quota": 10, "max": 100, "min": 0 } ] }}

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

请求示例 删除ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组内名称为test-hook1的生命周期挂钩。 DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1

返回值 正常 204 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

URI DELETE /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/{lifecycle_hook_name} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_group_id 是 String 伸缩组ID lifecycle_hook_name 是 String 生命周期挂钩名称

响应示例 { "lifecycle_hooks": [ { "lifecycle_hook_name": "test-hook1", "default_result": "ABANDON", "default_timeout": 3600, "notification_topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh", "notification_topic_name": "gsh", "lifecycle_hook_type": "INSTANCE_LAUNCHING", "notification_metadata": null, "create_time": "2016-11-18T04:01:34Z" }, { "lifecycle_hook_name": "test-hook2", "default_result": "CONTINUE", "default_timeout": 300, "notification_topic_urn": "urn:smn:regionId:a5b95554fad0494d94596fb84296510b:test", "notification_topic_name": "test", "lifecycle_hook_type": "INSTANCE_TERMINATING", "notification_metadata": null, "create_time": "2016-11-17T04:00:34Z" } ]}

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

响应参数 表2 响应参数 参数 参数类型 描述 lifecycle_hooks Array of lifecycle_hooks objects 生命周期挂钩列表，详情见表 lifecycle_hooks字段数据结构说明。 表3 lifecycle_hooks字段数据结构说明 参数 参数类型 描述 lifecycle_hook_name String 生命周期挂钩名称。 lifecycle_hook_type String 生命周期挂钩类型。 INSTANCE_TERMINATING INSTANCE_LAUNCHING default_result String 生命周期挂钩默认回调操作。 ABANDON CONTINUE default_timeout Integer 生命周期挂钩超时时间，单位秒。 notification_topic_urn String SMN 服务中 Topic 的唯一的资源标识。 notification_topic_name String SMN 服务中 Topic 的资源名称。 notification_metadata String 自定义通知消息。 create_time String 创建生命周期挂钩时间，遵循UTC时间。

响应示例 { "versions": [ { "id": "v1", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2016-06-30T00:00:00Z", "version": "" }, { "id": "v2", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v2/", "rel": "self" } ], "min_version": "", "status": "SUPPORTED", "updated": "2018-03-30T00:00:00Z", "version": "" } ]}

响应参数 表1 响应参数 参数 参数类型 描述 versions Array of versions objects 描述弹性伸缩API版本信息列表。 表2 versions字段数据结构说明 参数 参数类型 描述 id String API版本ID links Array of links objects API 的url地址，详情请见表3 links字段数据结构说明。 min_version String API支持的最小微版本号。 status String API版本状态： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还在继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 updated String API版本发布时间 version String API支持的最大微版本号 表3 links字段数据结构说明 参数 参数类型 描述 href String API的url地址 rel String API的url地址依赖

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

弹性伸缩配置 权限 对应API接口 授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 创建弹性伸缩配置 POST /autoscaling-api/v1/{project_id}/scaling_configuration as:configs:create √ √ 查询弹性伸缩配置列表 GET /autoscaling-api/v1/{project_id}/scaling_configuration as:configs:list √ √ 查询弹性伸缩配置详情 GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id} as:configs:get √ √ 删除弹性伸缩配置 DELETE /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id} as:configs:delete √ √ 批量删除弹性伸缩配置 POST /autoscaling-api/v1/{project_id}/scaling_configurations as:configs:batchDelete √ √ 父主题： 权限和授权项

伸缩策略执行日志 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询策略执行日志 GET /autoscaling-api/v1/{project_id}/scaling_policy_execute_log/{scaling_policy_id} as:policyExecuteLogs:list √ √ 父主题： 权限和授权项

通知 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 配置伸缩组通知 PUT /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id} as:notifications:set √ √ 查询伸缩组通知列表 GET /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id} as:notifications:list √ √ 删除伸缩组通知 DELETE /autoscaling-api/v1/{project_id}/scaling_notification/{scaling_group_id}/{topic_urn} as:notifications:delete √ √ 父主题： 权限和授权项

响应示例 { "page_info": { "next_marker": "xxxx" }, "scheduled_tasks": [ { "task_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3", "name": "task_01", "scheduled_policy": { "start_time": "2016-01-0T17:31Z", "end_time": "2016-02-08T17:31Z", "launch_time": "17:00", "recurrence_type": "Daily" }, "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "instance_number": { "max": 10 } } ]}

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成，服务异常。 501 Not Implemented 请求未完成，服务器不支持所请求的功能。 502 Bad Gateway 请求未完成，服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成，系统暂时异常。 504 Gateway Timeout 网关超时。

响应参数 表2 响应参数 参数 是否必选 参数类型 描述 page_info 否 Object 分页信息，请参见表3 scheduled_tasks 否 Array of objects 计划任务列表，请参见表4 表3 page_info字段数据结构说明 参数 是否必选 参数类型 描述 next_marker 否 String 下一页的marker 表4 scheduled_tasks字段数据结构说明 参数 是否必选 参数类型 描述 task_id 否 String 计划任务ID scaling_group_id 否 String 伸缩组ID name 否 String 计划任务名称 scheduled_policy 否 Object 计划任务策略，请参考表5 instance_number 否 Object 伸缩组实例数，请参考表6 create_time 否 String 创建时间 tenant_id 否 String 租户ID domain_id 否 String 帐号ID update_time 否 String 更新时间 表5 scheduled_policy字段数据结构说明 参数 是否必选 参数类型 描述 start_time 否 String 计划任务的生效开始时间。仅当recurrence_type不为空时生效，格式为yyyy-MM-dd'T'HH:mm'Z'，不填写时默认为任务创建成功的时间。 end_time 否 String 计划任务的生效结束时间。仅当recurrence_type不为空时生效且必选，格式为yyyy-MM-dd'T'HH:mm'Z'。 launch_time 是 String 计划任务的执行时间。采用UTC时间，当recurrence_type不填写或为空时,格式为yyyy-MM-dd'T'HH:mm'Z'，当recurrence_type不为空时，格式为HH:mm。 recurrence_type 否 String 不填写或为空时计划任务为定时执行，填写时计划任务为周期执行，且只能填写DAILY、WEEKLY、MONTHLY 中的一种，分别为按天、按周、按月周期执行。 recurrence_value 否 String 仅当recurrence_type为WEEKLY、MONTHLY时必选，表示周期执行的具体日期，多个日期用,分割，当recurrence_type为WEEKLY时，可填入1-7，当recurrence_type为MONTHLY时，可填入1-31。 表6 instance_number字段数据结构说明 参数 是否必选 参数类型 描述 max 否 Integer 伸缩组最大实例数 min 否 Integer 伸缩组最小实例数 desire 否 Integer 伸缩组期望实例数