华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result String 请求结果。 状态码: 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}/clickhouse/users/password 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例ID,严格匹配UUID规则。
  • 请求示例 修改数据库账户密码。 PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/users/password{ "user_name" : "user_test0", "password" : "Clickhouse_1234"}
  • 请求示例 修改数据同步白名单。 PUT https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/databases/replication/config{ "source_instance_id" : "5a377c0073cd4264be308fd968e60312in07", "source_node_id" : "", "database" : "db1", "value" : "{\"white_list\":\"t1,t2,t3\"}"}
  • URI PUT /v3/{project_id}/instances/{instance_id}/clickhouse/databases/replication/config 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例ID,严格匹配UUID规则。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 source_instance_id 是 String 源实例ID,严格匹配UUID规则。 source_node_id 否 String 源实例节点ID。 database 是 String 数据库名。 value 是 String 配置值。仅支持修改同步范围,不支持修改白名单或黑名单类型。 例如:创建了白名单数据同步,调用本接口修改时, 支持 "value":"{"white_list":"test1,test2,test3"}" 不支持 "value":"{"black_list":"test1,test2,test3"}"
  • 响应参数 状态码: 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 表3 响应Body参数 参数 参数类型 描述 recycle_policy RecyclePolicy object 回收站策略。 表4 RecyclePolicy 参数 参数类型 描述 retention_period_in_days String 保留天数,1-7天。 状态码: 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。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值:application/json。 X-Language 否 String 语言。
  • 响应示例 状态码: 200 Success. { "proxy_flavor_groups" : [ { "group_type" : "X86", "proxy_flavors" : [ { "id" : "19be4c5d-d363-3342-bdbc-0dd9dbf7fafe", "spec_code" : "gaussdb.proxy.large.x86.2", "vcpus" : 2, "ram" : 4, "db_type" : "Proxy", "az_status" : { "az1" : "normal" } } ] } ]}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 proxy_flavor_groups Array of MysqlProxyFlavorGroups objects 规格组信息。 表4 MysqlProxyFlavorGroups 参数 参数类型 描述 group_type String 规格组类型,如x86、arm。 proxy_flavors Array of MysqlProxyComputeFlavor objects 规格信息。 表5 MysqlProxyComputeFlavor 参数 参数类型 描述 vcpus String CPU大小。例如:1表示1U。 ram String 内存大小,单位为GB。 db_type String 数据库类型。 id String 数据库代理规格ID。 spec_code String 数据库代理规格码。 az_status Object 其中key是可用区编号,value是规格所在AZ的状态。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 node_num 是 Integer 数据库代理节点缩容操作需要减少的节点数。 缩容的节点数的取值范围:1~14之间的整数。 限制条件:该实例的数据库代理节点的总数量小于等于16,大于等于2。
  • 响应参数 状态码: 201 表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}/reduce 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID,严格匹配UUID规则。 proxy_id 是 String 数据库代理ID,严格匹配UUID规则。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 user_details Array of user_details objects 数据库账户信息。 total_count Integer 数据库账户数量。 表5 user_details 参数 参数类型 描述 user_name String 数据库账户名。 data_bases Array of strings 已授权数据库。 dml Integer DML授权。 0:读写权限 1:只读权限 2:只读和设置权限 3:读写和设置权限 ddl Integer DDL授权。 0:无DDL权限 1:有DDL权限 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 Success. { "user_details" : [ { "user_name" : "root", "data_bases" : [ "*" ], "dml" : 2, "ddl" : 0 }, { "user_name" : "user_test", "data_bases" : [ "*" ], "dml" : 2, "ddl" : 0 } ], "total_count" : 2}
  • URI GET /v3/{project_id}/instances/{instance_id}/starrocks/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID,严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 数据库账户。 limit 是 Integer 查询记录数,不能为负数,最小值为1,最大值为100。 offset 是 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。
  • 响应示例 状态码: 200 Success. { "instance_id" : "61a4ea66210545909d74a05c27a7179ein07", "instance_name" : "gauss-test-1", "switch_status" : { "scaling_switch" : "ON", "flavor_switch" : "ON", "read_only_switch" : "ON" }}
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 switch_status AutoScalingSwitchStatus object 开关状态。 表6 AutoScalingSwitchStatus 参数 参数类型 描述 scaling_switch String 自动变配开关状态。 取值: ON:开启。 OFF:关闭。 flavor_switch String 扩缩规格开关状态。 取值: ON:开启。 OFF:关闭。 read_only_switch String 增删只读节点开关状态。 取值: ON:开启。 OFF:关闭。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 设置自动变配。 PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/auto-scaling/policy{ "enlarge_threshold" : 50, "max_flavor" : "gaussdb.mysql.large.x86.4", "max_read_only_count" : 2, "monitor_cycle" : 300, "read_only_weight" : 10, "reduce_enabled" : false, "scaling_strategy" : { "flavor_switch" : "ON", "read_only_switch" : "ON" }, "silence_cycle" : 300, "status" : "ON"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值:application/json。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 status 是 String 自动变配开关状态。 取值: ON:开启。 OFF:关闭。 scaling_strategy 是 ScalingStrategyReqInfo object 自动变配策略。 monitor_cycle 否 Integer 监测周期(单位:秒)。 在整个观测窗口期内,若CPU平均使用率大于等于设定值,则在观测窗口结束后,进行扩容。 取值范围:300、600、900、1800。 status为ON时必填。 silence_cycle 否 Integer 静默周期(单位:秒)。 两次自动扩容或自动回缩的最小间隔时间。 取值范围:300、600、1800、3600、7200、10800、86400、604800。 status为ON时必填。 enlarge_threshold 否 Integer CPU平均使用率(百分比数值)。 取值范围:50-100。 status为ON时必填。 max_flavor 否 String 扩容规格上限。开启扩缩规格时必填。 reduce_enabled 否 Boolean 是否开启自动回缩。开启自动变配时必填。 true:是。 false:否。 max_read_only_count 否 Integer 只读节点数量上限。开启增删只读节点时必填。 read_only_weight 否 Integer 只读节点读写分离权重。开启增删只读节点时必填。 表4 ScalingStrategyReqInfo 参数 是否必选 参数类型 描述 flavor_switch 是 String 扩缩规格开关。 ON:开启。 OFF:关闭。 read_only_switch 是 String 增删只读节点开关。自动增删只读节点功能需要先开启数据库代理,且只能有一个代理。 ON:开启。 OFF:关闭。
  • 响应参数 状态码: 202 表5 响应Body参数 参数 参数类型 描述 job_id String 修改数据库备注的任务ID。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 修改数据库备注。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases/comment{ "databases" : [ { "name" : "gaussdb_mysql_user1", "comment" : "first_database" } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 alias 是 String 实例备注。 长度可在0~64个字符之间,由字母、数字、汉字、英文句号、下划线、中划线组成。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 security_group_id 是 String 安全组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。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 port 是 Integer 端口号。 TaurusDB端口号范围:大于等于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 错误消息。
  • 响应参数 状态码: 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 错误消息。
  • 请求示例 修改指定企业项目的资源配额。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas{ "quota_list" : [ { "enterprise_project_id" : "0", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 } ]}
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全