云服务器内容精选

  • 请求示例 开启SQL限流。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/ 49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit/switch { "db_name" : "postgres", "id" : "1", "action" : "open" }
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/sql-limit?db_name={db_name}&offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 db_name 是 String 数据库名称。 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 Integer 查询记录数。默认为10,不能为负数,最小值为1,最大值为100。
  • 响应消息 正常响应要素说明 表2 字段说明 名称 参数类型 说明 count Integer SQL限流总数。 sql_limit_objects Array of objects SQL限流详情。 请参见表3。 表3 sql_limit_objects字段数据结构说明 名称 参数类型 说明 id String SQL限流ID。 query_id String 由SQL的语法解析树计算出的内部哈希码,默认为0,取值范围:-9223372036854775808~ 9223372036854775807。 query_string String SQL语句的文本形式。 max_concurrency Integer 同时执行的SQL数量,小于等于0表示不限制,默认为0,取值范围:-1~50000。 is_effective Boolean 是否生效。 max_waiting Integer 最大等待时间,单位为秒。 search_path String 为不是模式限定的名称设置模式搜索顺序,默认为public。 正常响应样例 { "count": 2, "sql_limit_objects": [ { "id": "3", "query_id": "1147616880456321454", "query_string": "select 1;", "max_concurrency": 10, "is_effective": false, "max_waiting": 10, "search_path": "public" }, { "id": "4", "query_id": "-7472493489976133824", "query_string": "select * from pg_type;", "max_concurrency": 10, "is_effective": false, "max_waiting": 10, "search_path": "public" } ] } 异常响应 请参见异常请求结果。
  • 请求示例 修改SQL限流。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit/update { "db_name" : "postgres", "id" : "1", "max_concurrency" : 10, "max_waiting" : 10 }
  • 请求示例 新增SQL限流。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit { "db_name" : "postgres", "query_id" : 1, "max_concurrency" : 10, "max_waiting" : 10, "search_path" : "public" }
  • 请求消息 表2 参数说明 参数 是否必选 参数类型 描述 db_name 是 String 数据库名称。 query_id 否 Long 由SQL的语法解析树计算出的内部哈希码,默认为0,取值范围:-9223372036854775808~ 9223372036854775807。 query_string 否 String SQL语句的文本形式。query_id与query_string只可以存在一个。 max_concurrency 是 Integer 同时执行的SQL数量,小于等于0表示不限制,默认为0,取值范围:-1~50000。 max_waiting 是 Integer 最大等待时间,单位为秒。 search_path 否 String 为不是模式限定的名称设置模式搜索顺序,默认为public。
  • 响应消息 正常响应要素说明 表2 参数说明 名称 参数类型 说明 total_count Integer 总记录数。 upgrade_reports Array of objects 升级报告信息。 详情请参见表3。 表3 upgrade_report字段数据结构说明 名称 参数类型 说明 id String 升级报告ID。 start_time String 升级开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 end_time String 升级结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 src_instance_id String 原实例ID。 src_database_version String 原数据库版本。 dst_instance_id String 目标实例ID。 dst_database_version String 目标数据库版本。 result String 升级结果。 success:表示成功。 failed:表示失败。 running:表示升级中。 is_private_ip_changed Boolean 是否将实例内网IP切换到目标大版本实例。 true:表示切换。 false:表示不切换。 private_ip_change_time String 实例内网IP修改时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 statistics_collection_mode String 统计信息收集模式。 before_change_private_ip:修改实例内网IP前收集。 after_change_private_ip:修改实例内网IP后收集。 detail String 升级报告详情。 正常响应样例 { "total_count": 1, "upgrade_reports": [ { "id": "1a8fda5a-17a6-ebc4-bf1f-97ae837f432b", "start_time": "2023-03-06T02:45:49+0800", "end_time": "2023-03-06T02:50:49+0800", "src_instance_id": "dccacebb7b884ee18bc5c02c918ef2b0in03", "src_database_version": "13.9", "dst_instance_id": "6b5750504be1403191c4f00e4ffaee5ein03", "dst_database_version": "14.6", "result": "success", "is_private_ip_changed": true, "private_ip_change_time": "2023-03-06T03:10:49+0800", "statistics_collection_mode": "before_change_private_ip", "detail": "2023-03-06 18:33:26 --- pg_upgrade upgrade task begin" } ] } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/major-version/upgrade-histories?offset={offset}&limit={limit}&order={order}&sort_field={sort_field} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id String 是 实例ID。 offset Integer 否 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit Integer 否 查询记录数。默认为10,不能为负数,最小值为1,最大值为100。 order String 否 排序方式。 DESC:降序。 ASC:升序。 默认为降序。 sort_field String 否 排序字段。 start_time:开始时间。 end_time:结束时间。 默认为开始时间。
  • 请求消息 请求参数 名称 参数类型 是否必选 说明 target_version String 是 目标版本。 高于实例当前的大版本,如当前为12,目标版本需要是13或14。 is_change_private_ip Boolean 是 是否将实例内网IP切换到目标大版本实例。 true:升级后切换当前实例的内网IP到目标大版本实例。 false:升级后当前实例的内网IP不变,目标大版本实例使用新的内网IP。 statistics_collection_mode String 否 统计信息收集方式。“is_change_private_ip”为“true”时必选。 before_change_private_ip:将实例内网IP切换到目标大版本实例前收集。 after_change_private_ip:将实例内网IP切换到目标大版本实例后收集。 请求参数样例 https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/upgrade { "target_version": "14.6.1", "is_change_private_ip": true, "statistics_collection_mode": "before_change_private_ip" }
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/major-version/inspection-histories?offset={offset}&limit={limit}&order={order}&sort_field={sort_field}&target_version={target_version}&is_available={is_available} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id String 是 实例ID。 offset Integer 否 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit Integer 否 查询记录数。默认为10,不能为负数,最小值为1,最大值为100。 order String 否 排序方式。 DESC:降序。 ASC:升序。 默认为降序。 sort_field String 否 排序字段。 check_time:检查时间。 expiration_time:过期时间。 默认为检查时间。 target_version String 否 目标版本。 is_available Boolean 否 是否有效。 true:表示有效。 false:表示无效。
  • 响应消息 正常响应要素说明 表2 参数说明 名称 参数类型 说明 total_count Integer 总记录数。 inspection_reports Array of objects 检查报告信息。 详情请参见表3。 表3 inspection_report字段数据结构说明 名称 参数类型 说明 id String 检查报告ID。 check_time String 检查时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 expiration_time String 到期时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 target_version String 目标版本。 result String 检查结果。 success:表示成功。 failed:表示失败。 running:表示检查中。 detail String 检查报告详情。 正常响应样例 { "total_count": 1, "inspection_reports": [ { "id": "289903e1-3006-19e9-e054-5fb7fe376552", "check_time": "2023-03-06T02:33:49+0800", "expiration_time": "2023-03-07T02:33:49+0800", "target_version": "14.4", "result": "success", "detail": "2023-03-06 18:33:26 --- pg_upgrade check task begin\n2023-03-06 18:34:40 --- pg_upgrade check on master: [user_check_report]User check success" } ] } 异常响应 请参见异常请求结果。
  • 响应消息 正常响应要素说明 表2 参数说明 名称 参数类型 说明 status String 实例大版本升级状态 running:预检查或大版本升级进行中。 success:预检查或大版本升级成功。 failed:预检查或大版本升级失败。 target_version String 目标版本。 start_time String 开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 check_expiration_time String 检查成功时,报告到期时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 detail String 预检查或升级报告信息。 正常响应样例 { "status": "success", "target_version": "14.4.1", "start_time": "2023-03-06T02:33:49+0800", "check_expiration_time": "2023-03-13T02:33:49+0800", "detail": "2023-03-06 18:33:26 --- pg_upgrade check task begin\n2023-03-06 18:34:40 --- pg_upgrade check on master: [user_check_report]User check success " } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/major-version/status?action={current_action} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id String 是 实例ID。 action String 是 要查询的状态。 check:查询升级预检查的状态。 upgrade:查询大版本升级的状态。
  • 请求消息 请求参数 表2 参数说明 名称 参数类型 是否必选 说明 target_version String 是 目标版本。 URI样例 https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/inspection { "target_version": "14.9.0" }
  • 响应消息 正常响应要素说明 表3 字段说明 名称 参数类型 说明 diagnosis String 诊断项。 枚举值: high_pressure lock_wait insufficient_capacity slow_sql_frequency disk_performance_cap mem_overrun age_exceed connections_exceed total_count Integer 实例数量。 instances Array of objects 实例ID。 请参见表4。 表4 instances字段数据结构说明 名称 参数类型 说明 id String 实例ID。 正常响应样例 { "diagnosis" : "high_pressure", "total_count" : 1, "instances" : [ { "id" : "abd21a25fdedfd6db69721f4b761bc38in04" } ] } 异常响应 请参见异常请求结果。