云服务器内容精选

  • 请求示例 删除实例,删除关联后端数据库实例上存储的数据。 DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true 删除实例,保留关联后端数据库实例上存储的数据。 DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=false
  • 响应示例 状态码: 200 OK { "id" : "9608ce63-bf66-4342-be8a-44f9b6b15d54" } 状态码: 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码: 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }
  • URI DELETE /v1/{project_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 delete_rds_data 否 String 是否同时删除关联后端数据库实例上存储的数据。 取值为空或“true”:删除。 取值为“false”:不删除。 默认值为空。 枚举值: true false
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String DDM实例ID。 job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用 IAM 服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 管理员账号用户名。 长度为1-32个字符。 必须以字母开头。 可以包含字母,数字、下划线,不能包含其它特殊字符。 password 是 String 管理员账号密码。 长度为8~32位。 必须是大写字母(A~Z)、小写字母(a~z)、数字(0~9)、特殊字符~!@#%^*-_+?的组合。 建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。
  • 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 执行操作的用户名。 excute_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==" } ] } 异常响应 请参见异常请求结果。
  • 响应消息 正常响应参数说明 表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}/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 总条数。 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", "hots": "172.16.241.84:58908", "db": "ddm_db_test_0001", "state": "", "command": "Sleep", "info": null, "time": 13977, "trx_executed_time": 0 } ], "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。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String DDM实例组名称,命名要求如下。 长度为4-64个字符。 必须以字母开头。 可以包含字母、数字、中划线、下划线、不能包含其它特殊字符。 最小长度:4 最大长度:64 type 是 String 实例组的类型。 rw:读写组 r:只读组 flavor_id 是 String 规格ID。 nodes 是 Array of 表 NodeInfo objects 节点信息列表。 最小:1 最大:32 表4 NodeInfo 参数 是否必选 参数类型 描述 available_zone 是 String 节点可用区。取值非空,请参见地区和终端节点。 subnet_id 是 String 子网ID。
  • 响应消息 正常响应参数说明 表5 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 job_id String 创建组的任务ID。 仅创建按需实例时会返回该参数。 order_id String 订单号,创建包年包月时返回该参数。 正常响应示例 { "instance_id" : "28e8841d0b9c4f6a9a30742ee60e1055****", "job_id" : "1eb697c0-1842-43a3-8671-f562d038****" } 异常响应 请参见异常请求结果。
  • 请求示例 创建DDM实例组,组类型:读写,节点数为1个。 POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/groups { "name": "group-1", "type": "rw", "flavor_id": "a615922f-0ed8-3691-aad4-a595185febba", "nodes": [ { "available_zone": "az1", "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 变更至新规格的资源规格编码。 group_id 否 String 实例默认一个组,此时不需要传入该参数。当使用组功能创建多个组时, 需要传入需要规格变更的对应组的group_id。 is_auto_pay 否 Boolean 变更包年包月实例规格时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。true,表示自动从账户中支付。false,表示手动从账户中支付,默认为该方式。