云服务器内容精选

  • 响应消息 正常响应参数说明 表4 响应Body参数 参数 参数类型 描述 flavor_groups Array of FlavorGroupInfo objects 引擎信息列表。 表5 FlavorGroupInfo 参数 参数类型 描述 flavors Array of Flavor objects 引擎ID。 offset Integer 分页参数: 起始值。 limit Integer 分页参数:每页多少条。 total Integer 引擎信息总数。 表6 Flavor 参数 参数类型 描述 az_infos Array of AvailableZone objects 可用区信息。 normal:在售。 unsupported:暂不支持该规格。 sellout:售罄。 id String 规格ID。 spec_code String 资源规格编码。 vcpus String CPU大小。例如:1表示1U。 ram String 内存大小,单位:GB。 表7 AvailableZone 参数 参数类型 描述 code String 可用区CODE。 description String 可用区描述。 status String 可用区状态。 support_ipv6 Boolean 是否支持IPV6。
  • URI URL格式 GET /v3/{project_id}/flavors?engine_id={engine_id}&offset={offset}&limit={limit}&engine_version={engine_version}&available_zones={available_zones} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 engine_id 否 String 引擎ID,通过查询DDM引擎信息接口获取,引擎ID与引擎版本至少指定一个。 engine_version 否 String 引擎版本,通过查询DDM引擎信息接口获取,引擎ID与引擎版本至少指定一个。 available_zones 否 String 可用区,多个用","分割,如cn-southwest-244a,cn-southwest-244b。取值非空,请参见地区和终端节点。 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0。 取值必须为数字,且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围:1~128。 不传该参数时,默认值为10。
  • URI URL格式 GET /v3/{project_id}/instances/{instance_id}/processes-audit-log?offset={offset}&limit={limit}&start_time={start_time}&end_time={end_time} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID或关联RDS实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0。 取值必须为数字,且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围:1~128。 不传该参数时,默认值为10。 start_time 是 String 开始时间,UTC time,精确到毫秒。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 end_time 是 String 结束时间,UTC time,精确到毫秒。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。结束时间与开始时间,间隔不能超过7天。
  • 响应消息 正常响应参数说明 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总条数。 process_audit_logs Array of 表4 UserProcessAuditLog objects 实例的kill会话审计日志列表。 表5 UserProcessAuditLog 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 process_id String 会话ID。 execute_user_name String 执行操作的用户名。 execute_time String 操作时间,UTC time。 正常响应示例 { "total_count": 1, "process_audit_logs": [ { "instance_id": "5af0884170a84164980f79f9f5bf230c****", "instance_name": "UTS-ddm-name", "process_id": 6708736, "execute_user_name": "user_name", "execute_time": "2024-06-18T03:08:15+0800VGltZQ==" } ] } 异常响应 请参见异常请求结果。
  • URI URL格式 GET /v3/{project_id}/instances/{instance_id}/groups?offset={offset}&limit={limit} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0。 取值必须为数字,且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围:1~128。 不传该参数时,默认值为10。
  • 响应消息 正常响应参数说明 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总条数。 group_list Array of 表5 objects 实例的组信息列表。 表5 GroupInfo 参数 参数类型 描述 id String 组ID。 name String 组名称。 role String 组角色类型,分为读写组和只读组。 返回值: rw:读写组 r:只读组 endpoint String 组的连接地址。如果没有开启负载均衡,则返回的是组内节点的连接地址串。 ipv6_endpoint String 组IPv6的连接地址。 is_load_balance Boolean 是否开启负载均衡。 is_default_group Boolean 是否为默认组。 cpu_num_per_node Integer 单节点CPU的核数。 mem_num_per_node Integer 单节点的内存大小,单位为GB。 architecture String CPU架构。 返回值: X86 ARM node_list Array of 表6 objects 节点信息列表。 表6 GroupNodeInfo 参数 参数类型 描述 id String 节点ID。 name String 节点名称。 az String 节点所在的可用区。 正常响应示例 { "group_list":[ { "id":"****gr09", "name":"group-default", "role":"rw", "endpoint":"**.**.**.**:5066", "is_load_balance":true, "is_default_group":false, "architecture":"X86", "cpu_num_per_node":4, "mem_num_per_node":8, "node_list":[ { "id":"****no09", "name":"node_01", "az":"some_az" } ] } ], "total_count":1 } 异常响应 请参见异常请求结果。
  • URI URL格式 GET /v3/{project_id}/instances/{instance_id}/physical-processes?offset={offset}&limit={limit} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 关联RDS实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0。 取值必须为数字,且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围:1~128。 不传该参数时,默认值为10。 keyword 否 String 会话结果筛选关键字,支持返回结果全字段模糊匹配,长度最大255。
  • 响应消息 正常响应参数说明 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总条数。 physical_processes Array of 表5 objects 实例的物理会话列表。 表5 PhysicalProcessInfo 参数 参数类型 描述 id Long 物理会话ID。 user String 当前连接的用户。 host String 所属的IP和端口。 db String 数据库名。 command String 连接状态,一般是休眠或空闲(sleep),查询(query),连接(connect)。 time Long 连接状态持续的时间,单位是秒(s)。 state String 当前SQL语句的状态。 info String 当前所执行的SQL语句。 trx_executed_time Long 事务持续时间,单位是秒(s)。 正常响应示例 { "physical_processes": [ { "id": 1973, "user": "DDMRW1613058863", "host": "172.16.241.84:58908", "db": "ddm_db_test_0001", "state": "", "command": "Sleep", "info": null, "time": 13977, "trx_executed_time": 0 } ], "total_count": 1 } 异常响应 请参见异常请求结果。
  • 响应示例 状态码: 200 OK { "databases" : [ { "status" : "RUNNING", "created" : "1642063713625", "name" : "mytestdb170", "shard_mode" : "cluster", "shard_number" : 8, "shard_unit" : 8, "used_rds" : [ { "id" : "c6f68fed9e74478c8679479a07d7d568in01", "status" : "normal", "name" : "rds-test" } ] } ], "total" : 172 } 状态码: 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码: 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 databases Array of GetDatabaseInfo objects 逻辑库相关信息的集合。 total Integer 总条数。 表5 GetDatabaseInfo 参数 参数类型 描述 name String 逻辑库名称。 shard_mode String 逻辑库的工作模式。 cluster表示逻辑库是拆分模式。 single表示逻辑库是非拆分模式。 shard_number Integer 同一种工作模式下逻辑库分片的数量。 status String 逻辑库状态。 created String 逻辑库的创建时间。 used_rds Array of GetDatabaseUsedRds objects 逻辑库关联的RDS实例信息。 shard_unit Integer 单个RDS上的逻辑库分片数。 表6 GetDatabaseUsedRds 参数 参数类型 描述 id String 关联RDS节点ID。 name String 关联RDS名称。 status String 关联RDS状态。 error_msg String 响应信息,若无异常信息则不返回该参数。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。
  • URI GET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0。 取值必须为数字,且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围:1~128。 不传该参数时,默认值为10。
  • URI URL格式 DELETE /v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data={delete_dn_data} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 database_name 是 String 逻辑库名称。
  • 请求示例 删除逻辑库(删除关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data=true 删除逻辑库(保留关联后端数据库实例上存储的数据)。 DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{database_name}?delete_dn_data=false
  • 响应消息 正常响应参数说明 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总条数。 logical_processes Array of 表5 objects 实例的逻辑会话列表。 表5 logicalProcessesInfo 参数 参数类型 描述 id String 逻辑会话ID。 user String 当前连接的用户。 host String 所属的IP和端口。 db String 数据库名。 command String 连接状态,一般是休眠(sleep),查询(query),连接(connect)。 time String 连接状态持续的时间,单位是秒(s)。 state String 当前SQL语句的状态。 info String 当前所执行的SQL语句。 正常响应示例 { "logical_processes": [ { "id": "4564224", "user": "drdsagent", "host": "127.0.0.1:54486", "db": "None", "command": "Query", "time": "0", "state": "starting", "info": "show processlist" } ], "total_count": 1 } 异常响应 请参见异常请求结果。
  • URI URL格式 GET /v3/{project_id}/instances/{instance_id}/logical-processes?offset={offset}&limit={limit} 参数说明 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0。 取值必须为数字,且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围:1~128。 不传该参数时,默认值为10。 keyword 否 String 会话结果筛选关键字,支持返回结果全字段模糊匹配,长度最大255。