华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 修改实例名称的任务ID 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称。 用于表示实例的名称,同一租户下,同类型的实例名可重名。取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 port 是 Integer 端口号。 GaussDB(for MySQL)端口号范围:大于等于1024,小于等于65535,不包含端口5342-5345、12017、20000、20201、20202、33062、33071。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 修改指定企业项目的资源配额。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas{ "quota_list" : [ { "enterprise_project_id" : "0", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 } ]}
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 quota_list Array of setQuota objects 资源列表对象。 表6 setQuota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 instance_quota Integer 实例个数配额。取值范围0~100000。(如果已经存在实例,应该大于已经存在的实例个数) vcpus_quota Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的cpu个数) ram_quota Integer 内存使用配额,单位为GB。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的内存数) 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 quota_list 是 Array of setQuota objects 资源列表对象。 表4 setQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_quota 否 Integer 实例个数配额。取值范围0~100000。(如果已经存在实例,应该大于已经存在的实例个数) vcpus_quota 否 Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的cpu个数) ram_quota 否 Integer 内存使用配额,单位为GB。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的内存数)
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 修改秒级监控的任务流ID 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 monitor_switch 是 Boolean 实例秒级监控开关。 true:开启 false:关闭 period 否 Integer 采集周期,仅在monitor_switch为true时生效。默认为5s。monitor_switch为false时,不传该参数。取值: 1:采集周期为1s。 5:采集周期为5s。 枚举值: 1 5
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 修改实例名称的任务id 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token X-Language 否 String 语言 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称。 用于表示实例的名称,同一租户下,同类型的实例名可重名。取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。
  • 请求示例 开启数据库代理的会话一致性。 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/d512257ecca04d96a0f3a9021018a385in07/proxy/7bf4a8bbb4f4fb58233a242ee13603bpo01/session-consistence{ "session_consistence" : true}
  • URI PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/session-consistence 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 租户在某一project下的实例ID。 proxy_id 是 String 租户在某一instance下的数据库代理ID。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 缺省值:en-us 表3 请求Body参数 参数 是否必选 参数类型 描述 session_consistence 是 String 会话一致性。 取值"true"时表示会话一致性开启。 取值"false"时表示会话一致性关闭。
  • 请求示例 开启数据库代理的会话连接池。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/5881e1ca66af4aefbc64dc2874e55b3fpo01/connection-pool-type{ "connection_pool_type" : "SESSION"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • URI PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/connection-pool-type 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID,严格匹配UUID规则。 proxy_id 是 String 数据库代理ID,严格匹配UUID规则。
  • 请求示例 POST https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/quotas{ "quota_list" : [ { "enterprise_project_id" : "0", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token X-Language 否 String 语言 表3 请求Body参数 参数 是否必选 参数类型 描述 quota_list 是 Array of setQuota objects 资源列表对象。 表4 setQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_quota 是 Integer 实例个数配额。取值范围0~1000。(如果已经存在实例,应该大于已经存在的实例个数) vcpus_quota 是 Integer CPU核数配额。取值范围0~3600000。(如果已经存在实例,应该大于已经占用的cpu个数) ram_quota 是 Integer 内存使用配额,单位为GB。取值范围0~19200000。(如果已经存在实例,应该大于已经占用的内存数)
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 quota_list Array of setQuota objects 资源列表对象。 表6 setQuota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 instance_quota Integer 实例个数配额。取值范围0~1000。(如果已经存在实例,应该大于已经存在的实例个数) vcpus_quota Integer CPU核数配额。取值范围0~3600000。(如果已经存在实例,应该大于已经占用的cpu个数) ram_quota Integer 内存使用配额,单位为GB。取值范围0~19200000。(如果已经存在实例,应该大于已经占用的内存数) 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 修改备份策略 POST https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update{ "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,3,4,5" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token X-Language 否 String 语言 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_policy 是 MysqlBackupPolicy object 数据库信息。 表4 MysqlBackupPolicy 参数 是否必选 参数类型 描述 start_time 是 String 备份时间段。自动备份将在该时间段内触发。取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。HH取值必须比hh大1。mm和MM取值必须相同,且取值必须为00。取值示例:21:00-22:00 keep_days 是 Integer 备份文件的保留天数。 period 是 String 备份周期配置。自动备份将在每星期指定的天进行。取值范围:格式为逗号隔开的数字,数字代表星期。取值示例:1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。 retention_num_backup_level1 否 Integer 1级备份保留数量,默认值为0。当一级备份开关开启时,该参数值有效。取值:0或1
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 status String 状态信息 instance_id String 实例ID instance_name String 实例名称 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 开启SQL限流。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch{ "switch_status" : "ON"} 关闭SQL限流。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch{ "switch_status" : "OFF"}
  • 概述 云数据库 GaussDB(for MySQL)是华为自研的最新一代企业级高扩展海量存储分布式数据库,完全兼容MySQL。基于华为最新一代DFV存储,采用计算存储分离架构,128TB的海量存储,无需分库分表,数据0丢失,既拥有商业数据库的高可用和性能,又具备开源低成本效益。 DFV(Data Function Virtualization)是一个与数据库垂直整合的高性能,高可靠的分布式存储系统。存储集群采取池化部署,可以有效提升存储使用效率。 您可以使用本文档提供API对数据库实例进行相关操作。支持的全部操作请参见API概览。 在调用云数据库 GaussDB(for MySQL) API之前,请确保已经充分了解GaussDB(for MySQL)相关概念,详细信息请参见《云数据库 GaussDB(for MySQL) 用户指南》的“产品介绍”。 父主题: 使用前必读
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 开启/关闭SQL限流任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 关闭数据库代理的事务拆分。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/6b030d160ac24eda9a5320fb38dc2d0ain07/proxy/transaction-split{ "transaction_split" : "NO", "proxy_id_list" : [ "2a2060f2486e4a47934182d91a3b53d2po01" ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 工作流ID 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
共100000条