华为云用户手册

  • URI PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/route-mode 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID,严格匹配UUID规则。 proxy_id 是 String 数据库代理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参数 参数 是否必选 参数类型 描述 route_mode 是 Integer 数据库代理路由模式。 取值范围: 0:表示权重负载模式。 1:表示负载均衡模式(数据库主节点不接受读请求)。 2:表示负载均衡模式(数据库主节点接受读请求)。 master_weight 否 Integer 主节点权重: 如果路由模式为0,取值为0~1000。 如果路由模式为1,取值为0。 如果路由模式为2,取值为1。 readonly_nodes 否 Array of ModifyProxyRouteWeightReadonlyNode objects 只读节点权重配置信息。 new_node_auto_add_status 否 String 是否开启新增节点自动加入该Proxy。如果需要设置是否开启新增节点自动加入该Proxy,请联系客服人员添加白名单,加入白名单后,方可输入该字段。 取值范围: ON:开启。 OFF:关闭。 new_node_weight 否 Integer 新增节点的读权重: 如果路由模式为0,新增节点自动加入为ON,取值为0~1000。 如果路由模式不为0或新增节点自动加入为OFF,则可不输入读权重。 表4 ModifyProxyRouteWeightReadonlyNode 参数 是否必选 参数类型 描述 id 是 String 只读节点ID。 weight 是 Integer 只读节点权重: 如果路由模式为0,取值为0~1000; 如果路由模式为1或2,取值为0或1。
  • 响应参数 状态码: 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。(如果已经存在实例,应该大于已经占用的内存数)
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表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。(如果已经存在实例,应该大于已经占用的内存数)
  • 请求参数 表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
  • URI PUT /v3/{project_id}/instances/{starrocks_instance_id}/starrocks/{starrocks_node_id}/restart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 starrocks_node_id 是 String StarRocks节点ID starrocks_instance_id 是 String StarRocks实例ID,严格匹配UUID规则。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 workflow_id String 工作流ID。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表5 响应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 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 recycle_policy 否 RecyclePolicy object 回收站策略。 表4 RecyclePolicy 参数 是否必选 参数类型 描述 retention_period_in_days 是 String 保留天数,1-7天。
  • 响应示例 状态码: 200 Success. { "total_count" : 1, "records" : [ { "id" : "2f5f3eeb-16c7-4b0c-bd44-4b2968275abe", "instance_id" : "94bb6ce031424d02a1c61019d1d2298bin07", "instance_name" : "gaussdbformysql-ins01", "scaling_type" : "ENLARGE_FLAVOR", "original_value" : "gaussdb.mysql.medium.x86.4", "target_value" : "gaussdb.mysql.large.x86.4", "result" : "SUC CES SFUL", "create_at" : "2023-04-30 16:47:40.877" } ]}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值:application/json。 X-Language 否 String 语言。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count String 记录总数。 records Array of AutoScalingRecordInfo objects 自动变配历史记录列表。 表5 AutoScalingRecordInfo 参数 参数类型 描述 id String 记录ID。 instance_id String 实例ID。 instance_name String 实例名称。 scaling_type String 变配类型。 original_value String 原始值。 target_value String 目标值。 result String 变配结果。 create_at String 变配时间。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • URI GET /v3/{project_id}/instances/{instance_id}/auto-scaling/history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 查询记录数。默认为20。 offset 否 String 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。
  • URI GET /v3/{project_id}/instances/{instance_id}/restore-time 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID,严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 date 否 String 所需查询的日期,为yyyy-mm-dd字符串格式,时区为UTC。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 restore_times Array of RestoreTimeInfo objects 可恢复时间段列表。 表5 RestoreTimeInfo 参数 参数类型 描述 start_time Long 可恢复时间段的起始时间点,UNIX时间戳格式,单位是毫秒,时区是UTC。 end_time Long 可恢复时间段的结束时间点,UNIX时间戳格式,单位是毫秒,时区是UTC。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 node_names Array of strings 节点名称列表。 job_id String 实例创建的任务id。 仅创建按需实例时会返回该参数。 order_id String 订单号,创建包年包月时返回该参数。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应示例 状态码: 201 Success. { "instance_id" : "f381d0b539e644df8f5b0d3a62129515in07", "node_names" : [ "gauss-ccf5_node03", "gauss-ccf5_node04" ], "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"}
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 priorities 是 Array of integers 指定创建的只读节点故障倒换优先级。倒换优先级列表个数即为只读节点格式。 故障倒换优先级的取值范围为1~16,数字越小,优先级越大,即故障倒换时,主节点会优先倒换到优先级高的备节点上,优先级相同的备节点选为主节点的概率相同。 is_auto_pay 否 String 创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 true,为自动支付,默认该方式。 false,为手动支付。 枚举值: true false
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 backup backup object 备份信息。 job_id String 任务ID。 表5 backup 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 description String 备份描述。 begin_time String 备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”,其中T指时间字段的开始;Z指时区偏移量。 status String 备份状态,取值: BUILDING:备份中。 COMPLETED:备份完成。 FAILED:备份失败。 AVAILABLE:备份可用。 type String 备份类型,手动全量备份,取值为manual。 instance_id String 实例ID,严格匹配UUID规则。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应示例 状态码: 201 Success. { "backup" : { "id" : "f58f674c11224fd99772b89f892da6f5br07", "name" : "backup-1", "description" : "手动备份", "begin_time" : "2020-07-07T01:17:05+0800", "status" : "BUILDING", "type" : "manual", "instance_id" : "ef25188419f941309882d2986b2210b9in07" }, "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"}
  • URI PUT /v3/{project_id}/instances/{instance_id}/starrocks/users/password 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID,严格匹配UUID规则。
  • 请求示例 修改数据库账户密码。 PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/starrocks/users/password{ "user_name" : "user_test", "password" : "Tang_1234"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 user_name 是 String 数据库账号名。 password 是 String 账户密码。 8-32个字符 不能与用户名或倒序的用户名相同 至少包含以下字符中的三种:大写字母、小写字母、数字和特殊字符~!@#%^*-_=+?,
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result String 请求结果。 状态码: 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。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 是 Array of strings 实例ID列表。列表长度限制在10以内。
  • URI GET /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID instance_id 是 String 实例ID。 proxy_id 是 String 数据库代理ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询记录数。默认为10,不能为负数,最小值为1,最大值为100。 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 name 否 String 参数名称,为空则全量查询。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count String 数据总数 configurations Array of ProxyConfiguration objects 内核可配置的参数列表 表5 ProxyConfiguration 参数 参数类型 描述 name String 参数名称 data_type String 参数数据类型 elem_type String 参数父标签类型 value_range String 取值范围 value String 参数默认值 description String 参数描述 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值:application/json。 X-Language 否 String 语言。
  • 响应示例 状态码: 200 Success. { "total_count" : 1, "configurations" : [ { "name" : "slowLogQueryTime", "data_type" : "integer", "elem_type" : "system", "value_range" : "200-50000", "value" : 500, "description" : "proxy慢日志阈值,默认值为500,单位ms。" } ]}
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 backup backup object 备份信息。 job_id String 工作流ID。 表5 backup 参数 参数类型 描述 id String 备份ID name String 备份名称。 descriprion String 备份描述。 begin_time String 备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”,其中T指时间字段的开始;Z指时区偏移量。 status Object 备份状态 枚举值: BUILDING:备份中。 COMPLETED:备份完成。 FAILED:备份失败。 AVAILABLE:备份可用。 type Object 备份类型,取值: 枚举值: manual:手动全量备份。 instance_id String 实例ID。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
共100000条
提示

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