云服务器内容精选

  • 响应参数 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码:200 成功响应。 { "count" : 0, "items" : [ { "id" : "1", "job_type" : "createServer", "begin_time" : "2022-03-07T10:40:43.858Z", "end_time" : "2022-03-07T10:40:43.858Z", "status" : "WAITING", "sub_jobs_total" : 10 } ] }
  • URI GET /v1/{project_id}/image-server-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String job状态: WAITING - 等待 RUNNING - 运行中 SUC CES S - 完成 FAILED - 失败 job_type 是 String job类型: CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer 查询的数量,值区间[1-100],默认值10。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of ImageJobInfo objects 任务信息列表,返回列表条目数量上限为分页的最大上限值。 表5 ImageJobInfo 参数 参数类型 描述 id String 任务ID。 job_type String job类型。 CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String job状态。 WAITING - 等待 RUNNING - 运行中 `SUCCESS - 完成 FAILED - 失败 sub_jobs_total Integer 子任务总数。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • URI GET https://{Endpoint}/v3/{project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 任务ID。 start_time 否 String 查询开始时间,默认当前时间往前30天,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始,Z指时区偏移量。 end_time 否 String 查询结束时间,默认当前时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间,时间跨度不超过30天。 其中,T指某个时间的开始,Z指时区偏移量。 status 否 String 任务状态。取值为“Running”为执行中。取值为“Completed”为完成。取值为“Failed”为失败。 name 否 String 任务名称。对应取值如下: "CreateInstance":创建实例。 "RestoreNewInstance":恢复到新实例。 "EnlargeInstance":扩容实例。 "ReduceInstance":缩容实例。 "RestartInstance":重启实例。 "RestartNode":重启节点。 "EnlargeInstanceVolume":扩容实例磁盘。 "ReduceInstanceVolume":缩容实例磁盘。 "ResizeInstance":规格变更实例。 "UpgradeDbVersion":升级数据库版本。 "BindPublicIP":绑定公网IP。 "UnbindPublicIP":解绑公网IP。 "DeleteInstance":删除实例。 "EnlargeInstanceColdVolume":扩容实例冷存储。 "AddInstanceColdVolume":增加实例冷存储。 "ModifySecurityGroup":修改安全组。 "ModifyCcmCert":修改CCM证书。 "ModifyPort":修改端口。 "ConstructDisasterRecovery":构造容灾关系。 "DeConstructDisasterRecovery":解除容灾关系。 "SwitchOverDisasterRecovery":切换容灾关系。 "BuildBiActiveInstance":构建双活实例。 "ReleaseBiActiveInstance":解除双活实例关系。 "BackupInstance":备份实例。 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 Integer 查询记录数。取值10,20,50 ,默认为50。
  • 响应示例 状态码: 200 Success { "total_count" : 1, "jobs" : [ { "id" : "6f85e061-04dd-42e7-86d6-d3b1e40aac2e", "name" : "CreateCassandra", "status" : "Running", "start_time" : "2023-09-12T06:44:01+0000", "end_time" : "2023-09-12T06:44:03+0000", "progress" : "14%", "instance" : { "id" : "27a045b6bf9e46f691f81366d398cb04in06", "name" : "nosql-12f5" }, "fail_reason" : "" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of 表5 objects 任务列表。 total_count Integer 任务列表总数。 表5 JobDetail 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务执行状态。取值: Running:表示任务正在执行。 Completed:表示任务执行成功。 Failed:表示任务执行失败。 start_time String 创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 end_time String 结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 progress String 任务执行进度。 说明: 执行中状态才返回执行进度,例如“60%”,表示任务执行进度为60%,否则返回“”。 instance 表6 object 任务关联的实例信息。 fail_reason String 任务执行失败时的错误信息。 表6 JobInstanceInfo 参数 参数类型 描述 id String 实例ID。 name String 实例名称。
  • 操作步骤 在“校验任务管理 ”页面,选择需要修改校验对象的任务,单击任务名称。 页面跳转至“基本信息”,切换到“对象选择”页签。 选择需要增加或者修改的表,单击操作列的“编辑”。 图1 对象选择 在“对象选择”页面,进行对象选择,可参考4。 在“校验规则”页,可选择需要的表进进行规则校验。 如果不需要校验规则,单击“下一步”。 如果需要进行校验规则,可参考5,设置相关规则。 在“预检查”页面,进行任务预校验,校验全部通过后,单击“下一步”。 在“任务确认”页面,确认校验任务信息无误后,单击“提交并启动”。
  • 响应示例 状态码: 200 查询合流转码成功,查询结果详情 { "job_id" : "607824b4fa163e19fe301cc817dda855", "stream_name" : "m_607824b4fa163e19fe301cc817dda855_gigu", "app_id" : "123456789abcdefghijklmno", "room_id" : "gigu", "mix_param" : { "room_id" : "gigu", "encode_template" : "1920x1080_30_4620", "max_idle_time" : 0, "layout_template" : "nine_grids_view" }, "record_param" : { "record_rule_id" : "5f5e172b9016ed5b0961a43" }, "create_time" : "2021-04-16T16:22:44Z", "update_time" : "2021-04-16T16:22:44Z", "state" : "INIT", "start_time" : "2021-04-16T16:22:44Z", "stop_time" : "0001-01-01T00:00:00Z"} 状态码: 404 查询合流转码失败,任务编号不存在 { "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"} 状态码: 500 查询合流转码失败,服务器端错误 { "error_code" : "RTC.00002xxx", "error_msg" : "InternalError"}
  • 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表4 响应Body参数 参数 参数类型 描述 job_id String 任务编号,可以用于修改、查看和停止合流任务 stream_name String 流名 app_id String 应用id room_id String 房间id mix_param MixParam object 合流参数 record_param RecordParam object 录制参数 create_time String 任务创建的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC update_time String 任务中的布局更新的时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC state String 任务状态。 INIT:任务正在初始化 RUNNING:任务正在运行 STOPPED:任务已停止 stop_reason String 任务结束原因 TENANT_STOP EXCEED_MAX_IDLE_TIME INTERNAL_ERROR description String 状态描述,对state字段的一些补充说明,可用于人工查阅。 start_time String 任务开始时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC stop_time String 任务结束时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC 表5 MixParam 参数 参数类型 描述 room_id String 房间id encode_template String 输出编码模板名称 1920*1080_30_4620:输出流是1080p,帧率30,码率4.62Mbps 1920*1080_30_3150:输出流是1080p,帧率30,码率3.15Mbps 1920*1080_15_3460:输出流是1080p,帧率15,码率3.46Mbps 1920*1080_15_2080:输出流是1080p,帧率15,码率2.08Mbps 1280*720_30_3420:输出流是720p,帧率30,码率3.42Mbps 1280*720_30_1710:输出流是720p,帧率30,码率1.71Mbps 1280*720_15_2260:输出流是720p,帧率15,码率2.26Mbps 1280*720_15_1130:输出流是720p,帧率15,码率1.13Mbps 640*480_30_1500:输出流是480p,帧率30,码率1.50Mbps 640*480_15_500:输出流是480p,帧率15,码率500Kbps 640*480_30_1000 输出流是480p,帧率30,码率1000Kbps 480*360_30_490:输出流是360p,帧率30,码率490Kbps 480*360_15_320:输出流是360p,帧率15,码率320Kbps max_idle_time Integer 最长空闲频道时间。 取值范围:[5,43200],默认值为30。 单位:秒。 如果频道内无连麦方的状态持续超过该时间,录制程序会自动退出。退出后,再次调用start请求,会产生新的录制任务。 连麦方指:joiner或者publisher的用户。 layout_template String 视频布局模板编号,不混视频的时候,不需要带。 nine_grids_view:九宫格模板(自适应模板) screen_share_left:主视图在左边的屏幕共享模板(自适应模板) screen_share_right:主视图在右边的屏幕共享模板(自适应模板) custom:自定义布局 default_user_background_image String 默认用户背景图地址,图片先上传obs,格式s3://bucket/object,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg。默认使用等比缩放裁剪,保证铺满。 screen_background_image String 共享屏幕的背景图地址,图片先上传obs,格式s3://bucket/object,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg。 在一大多小的布局场景下,无论大窗是显示非指定用户(屏幕共享人的桌面)还是指定用户的共享桌面,都通过该字段指定背景图。 background_image String 画布背景图地址,使用背景图功能需先上传图片到obs,填写此字段要求格式为s3://bucket/object,其中bucket和object指图片所在的桶和路径,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg。默认使用等比缩放裁剪,保证铺满。 layout_panes Array of MixLayoutPane objects 需要混流的视频列表。若不需要混流视频,则可不传递该参数。 nine_grids_view模板不需要填写本字段。 user_background_images Array of MixUserBackgroundImage objects 指定用户背景图,优先级大于default_user_background_image 表6 MixLayoutPane 参数 参数类型 描述 id Integer 窗口id,从1开始编号 user_id String 加入房间的用户id video_type String 标识视频流的类型,可选摄像头流或者屏幕分享流。 CAMERASTREAM:摄像头视频流 SCREENSTREAM:屏幕分享视频流 默认为CAMERASTREAM。 x Float 坐标x,归一化百分比,画布上该画面左上角的横坐标的相对值,范围是 [0.0,1.0]。从左到右布局,0.0在最左端,1.0在最右端,小数取值范围在float内,自定义布局场景下填写本字段。 y Float 坐标y,归一化百分比,画布上该画面左上角的纵坐标的相对值,范围是 [0.0,1.0]。从上到下布局,0.0在最上端,1.0在最下端,小数取值范围在float内,自定义布局场景下填写本字段。 width Float 窗格宽,归一化百分比,小数取值范围在float内,自定义布局场景下填写本字段。 height Float 窗格高,归一化百分比,小数取值范围在float内,自定义布局场景下填写本字段。 zorder Integer 叠放顺序,0为最底层,1层在0层之上,以此类推,最大支持25层,自定义布局场景下填写本字段。 crop_mode String 裁剪模式,自定义布局场景下填写本字段,支持两种模式: KEEP_RATIO_PADDING :保持比例留边。 KEEP_RATIO_CROP :保持比例裁剪。 filling_policy String 填充策略,仅限屏幕共享模板(包括screen_share_right、screen_share_left)场景下填写本字段,支持两种模式: FIXED_USER :固定用户填充。 SHARED_SCREEN :共享屏幕填充。 表7 MixUserBackgroundImage 参数 参数类型 描述 user_id String 需要设置背景图的用户ID image_uri String 需要设置背景图的地址,图片先上传obs,格式s3://bucket/object,如:s3://rtc-bucket-cn-north-4/img/testImg.jpg 表8 RecordParam 参数 参数类型 描述 record_rule_id String 录制规则id。 状态码: 404 表9 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表11 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。
  • 响应参数 状态码: 204 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 状态码: 404 表4 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表6 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。
  • 操作步骤 登录 主机迁移服务 管理控制台。 在左侧导航树中,单击“迁移服务器”,进入迁移服务器列表页面。 在迁移服务器列表页面找到待迁移的服务器,单击“迁移阶段/实时状态”或“操作”列的“开始”,右侧弹出“开始”窗口,单击“确定”,开始全量复制。 或勾选待迁移的服务器,单击服务器列表上方的“开始”,右侧弹出“开始”窗口,单击“确定”,开始全量复制。 图1 开始全量复制 在全量复制过程中,系统默认将您的目的端锁定并不可操作,迁移完成后将自动解锁目的端服务器。如您在迁移过程中,需要操作目的端,可解锁目的端,具体操作参见解锁目的端。 迁移过程中,您可以在服务器列表中,单击源端服务器名称,查看迁移进度。 全量复制完成。 在设置迁移目的端“持续同步”选择“否”时,全量复制完成后系统会自动进入下一步:启动目的端,并且启动目的端无需手动操作,系统会自动启动目的端。 在设置迁移目的端“持续同步”选择“是”时,“迁移实时状态”为“持续同步”,说明全量复制已完成。在“启动目的端”之前,系统会自动把源端新增或修改的磁盘数据持续同步到目的端。“启动目的端”需要手动操作,您可参考启动目的端来启动目的端。 在 主机迁移 并割接完成后,通常还需要您根据业务需要对目的端服务器进行一些额外的配置调整。详细介绍请参考主机迁移完成后还需要手动修改哪些配置项?
  • URI DELETE /autoscaling-api/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks/{scheduled_task_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_group_id 是 String 伸缩组ID scheduled_task_id 是 String 计划任务ID