云服务器内容精选

  • 支持查看的任务 表1 支持查看的任务 任务类型 分类 任务名称 即时任务 创建实例 创建SQL Server实例、创建SQL Server只读实例。 实例生命周期 重启SQL Server实例、停止SQL Server实例、开启SQL Server实例、删除SQL Server实例。 变更实例 扩容SQL Server实例、SQL Server实例主备倒换、克隆SQL Server实例、SOL Server单实例转主备、SQL Server规格变更、SQL Server磁盘类型变更、SQL Server实例迁移可用区、SQL Server修改字符集。 连接管理 SQL Server创建公网 域名 、SQL Server修改公网域名、SQL Server创建内网域名、SQL Server修改内网域名、SQL Server实例绑定弹性公网IP、SQL Server实例解绑弹性公网IP、SQL Server更新SSL证书。 备份与恢复 SQL Server恢复到新实例、SQL Server恢复到已有实例。 开启FileStream存储 SQL Server开启FileStream。 安全与加密 SQL Server开启TDE、SQL Server滚动TDE证书。 定时任务 实例生命周期 开启SQL Server实例、SQL Server实例系统升级。
  • 响应示例 状态码: 200 Success. { "jobs" : [ { "instance_id" : "ede953923f06448d9be8686ef0c1378ein07", "instance_name" : "gauss-1234", "instance_status" : "deleted", "job_id" : "7155730b-a60b-4dc0-9f89-3f55897f29d6", "order_id" : "", "job_name" : "Close GaussDB forMySQLProxy", "status" : "Completed", "process" : "", "created_time" : "2018-08-06T10:41:14+0000", "ended_time" : "2018-08-06T12:41:14+0000", "fail_reason" : null }, { "instance_id" : "ede953923f06448d9be8686ef0c1378ein07", "instance_name" : "gauss-1234", "instance_status" : "deleted", "job_id" : "335ab2a4-a038-4fa9-a62c-49dd84015011", "order_id" : "", "job_name" : "ResizeGaussDBforMySQLFlavor", "status" : "Failed", "process" : "", "created_time" : "2018-08-06T11:25:23+0000", "ended_time" : "2018-08-06T11:31:12+0000", "fail_reason" : "Single task exception." } ], "total_count" : 2 }
  • URI GET /v3/{project_id}/immediate-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 任务执行状态。 取值: Running:表示任务正在执行。 Completed:表示任务执行成功。 Failed:表示任务执行失败。 Pending:表示任务未执行。 job_name 否 String 任务名称。取值有: "CreateGaussDBforMySQLInstance"表示创建实例。 "RestoreGaussDBforMySQLNewInstance"表示恢复新实例。 "AddGaussDBforMySQLNodes"表示添加节点。 "DeleteGaussDBforMySQLNode"表示删除节点。 "RebootGaussDBforMySQLInstance"表示重启实例。 "ModifyGaussDBforMySQLPort"表示修改实例端口。 "ModifyGaussDBforMySQLSecurityGroup"表示修改实例安全组。 "ResizeGaussDBforMySQLFlavor"表示实例规格变更。 "SwitchoverGaussDBforMySQLMasterNode"表示只读升主。 "GaussDBforMySQLBindEIP"表示绑定弹性公网IP地址。 "GaussDBforMySQLUnbindEIP"表示解绑弹性公网IP地址。 "RenameGaussDBforMySQLInstance"表示修改实例名称。 "DeleteGaussDBforMySQLInstance"表示删除实例集群。 "UpgradeGaussDBforMySQLDatabaseVersion"表示版本升级。 "EnlargeGaussDBforMySQLProxy"表示实例的数据库代理节点扩容。 "OpenGaussDBforMySQLProxy"表示开启实例的数据库代理。 "CloseGaussDBforMySQLProxy"表示关闭实例的数据库代理。 "GaussdbforMySQLModifyProxyIp"表示修改数据库代理ip。 "ScaleGaussDBforMySQLProxy"表示实例的数据库代理节点规格变更。 "GaussDBforMySQLModifyInstanceMetricExtend"表示实例秒级监控。 "GaussDBforMySQLModifyInstanceDataVip"表示修改实例数据Vip。 "GaussDBforMySQLSwitchSSL"表示切换实例SSL开关。 "GaussDBforMySQLModifyProxyConsist"表示修改代理一致性。 "GaussDBforMySQLModifyProxyWeight"表示修改代理权重。 job_id 否 String 任务ID。 offset 否 String 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为1,必须为数字,不能为负数。 limit 否 String 查询记录数。默认为10,取值为10、20、50。 start_time 否 String 起始时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 end_time 否 String 结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of TaskDetailInfo objects 任务详情。 total_count Integer 任务总数。 表5 TaskDetailInfo 参数 参数类型 描述 instance_id String 实例ID,严格匹配UUID规则。 instance_name String 实例名称。 instance_status String 实例状态。 取值范围: createfail:表示实例创建失败。 creating:表示实例创建中。 normal:表示实例正常。 abnormal:表示实例异常。 deleted:表示实例已删除。 job_id String 任务ID。 order_id String 订单ID。 job_name String 任务名称。 取值范围有: CreateGaussDBforMySQLInstance:表示创建实例。 RestoreGaussDBforMySQLNewInstance:表示恢复新实例。 AddGaussDBforMySQLNodes:表示添加节点。 DeleteGaussDBforMySQLNode:表示删除节点。 RebootGaussDBforMySQLInstance:表示重启实例。 ModifyGaussDBforMySQLPort:表示修改实例端口。 ModifyGaussDBforMySQLSecurityGroup:表示修改实例安全组。 ResizeGaussDBforMySQLFlavor:表示实例规格变更。 SwitchoverGaussDBforMySQLMasterNode:表示只读升主。 GaussDBforMySQLBindEIP:表示绑定弹性公网IP地址。 GaussDBforMySQLUnbindEIP:表示解绑弹性公网IP地址。 RenameGaussDBforMySQLInstance:表示修改实例名称。 DeleteGaussDBforMySQLInstance:表示删除实例集群。 UpgradeGaussDBforMySQLDatabaseVersion:表示版本升级。 EnlargeGaussDBforMySQLProxy:表示实例的数据库代理节点扩容。 OpenGaussDBforMySQLProxy:表示开启实例的数据库代理。 CloseGaussDBforMySQLProxy:表示关闭实例的数据库代理。 GaussdbforMySQLModifyProxyIp:表示修改数据库读写分离地址。 ScaleGaussDBforMySQLProxy:表示实例的数据库代理节点规格变更。 GaussDBforMySQLModifyInstanceMetricExtend:表示实例秒级监控。 GaussDBforMySQLModifyInstanceDataVip:表示修改实例数据浮动IP。 GaussDBforMySQLSwitchSSL:表示切换实例SSL开关。 GaussDBforMySQLModifyProxyConsist:表示修改代理一致性。 GaussDBforMySQLModifyProxyWeight:表示修改代理权重。 status String 任务执行状态。 取值范围: Pending:表示延时任务,未执行。 Running:表示任务正在执行。 Completed:表示任务执行成功。 Failed:表示任务执行失败。 process String 任务进度。 created_time String 任务创建时间。格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 ended_time String 任务结束时间。格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 fail_reason String 任务失败原因。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 管理面任务中心 管理面任务中心功能,可用于查看创建图、备份图、启动图、增加备份、导入图、导出图、升级图等操作的异步任务的详情。 具体操作步骤如下: 在左侧导航栏,选择“任务中心” 在“任务中心”页面可以查看对应图所执行任务的类型,任务名称,图名称,关联图,开始时间,结束时间,状态和运行结果。 图1 任务中心 在“运行结果”列中可单击“查看详情”,查看“失败原因”和任务ID。 图2 查看详情 导入图时,如果任务状态为“部分成功”,可以单击“查看详情”,查看失败的数据“类型” ,“导入失败行数”等信息,失败的具体原因,请查看导入图时指定的日志路径(可选),失败的日志会上传到该路径下。 图3 部分成功 在“任务中心”页面,可以通过以下六种方式查找任务: 图4 查找任务方式 通过选择类型查找 通过任务名称查找 通过输入关联图进行查找 通过输入任务状态进行查找 通过输入任务ID进行查找 通过设置时间查找 父主题: 任务中心
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total_count Integer 作业总数 failed_count Integer 失败作业数量 succeed_count Integer 成功作业数量 id String 批量作业id error_list Array of strings 错误信息列表 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议
  • URI PUT /v2/{project_id}/batch-tasks/{id}/action/{command} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID,获取方法参见获取项目ID和名称 id 是 String 批量配置ID command 是 String 指定该API要对批量任务配置进行的操作,停止或者启动 枚举值:start|stop
  • 响应示例 状态码: 200 成功响应示例 { "job_id" : "ff80808167f09aaa0167f19b35ec0305", "status" : "success", "job_type" : "GraphManagement", "job_name" : "ImportGraph", "related_graph" : "GES_UI_AUTO", "begin_time" : "2018-11-27T21:39:00", "end_time" : "2018-11-27T21:39:56", "job_detail" : { "vertexset_path" : [ { "path" : "ges-ui/auDatas/list_set_vertex.csv", "log" : null, "cause" : null, "status" : "success" } ], "edgeset_path" : [ { "path" : "ges-ui/auDatas/list_set_edge.csv", "log" : null, "cause" : null, "status" : "success" } ], "schema_path" : [ { "path" : "ges-ui/auDatas/list_set_schema.xml", "log" : null, "cause" : null, "status" : "success" } ] }, "job_progress" : 0 } 状态码: 400 失败响应示例 { "error_msg" : "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1", "error_code" : "GES.8301" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 status String 任务状态。 pending:等待中。 running:运行中。 success:成功。 failed:失败。 job_type String 任务类型。 job_name String 任务名称。 related_graph String 关联图名称。 begin_time String 任务开始时间,格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" end_time String 任务结束时间,格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" job_detail job_detail object 只有jobName为ImportGraph时才返回,用于显示导入图详情。 fail_reason String 任务失败原因 job_progress Double 任务执行进度,预留字段,暂未使用。 表4 job_detail 参数 参数类型 描述 schema_path Array of schema_path objects 元数据路径。 edgeset_path Array of edgeset_path objects 边数据集路径。 vertexset_path Array of vertexset_path objects 点数据集路径。 表5 schema_path 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success:完全成功 failed:完全失败 partFailed:部分成功 cause String 导入失败原因。 total_lines Long 导入总行数。其值为-1时表示当前版本没有返回该字段。 failed_lines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successful_lines Long 导入成功行数。其值为-1时表示当前版本没有返回该字段。 表6 edgeset_path 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success:完全成功 failed:完全失败 partFailed:部分成功 cause String 导入失败原因。 total_lines Long 导入总行数。其值为-1时表示当前版本没有返回该字段。 failed_lines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successful_lines Long 导入成功行数。其值为-1时表示当前版本没有返回该字段。 表7 vertexset_path 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success:完全成功 failed:完全失败 partFailed:部分成功 cause String 导入失败原因。 total_lines Long 导入总行数。其值为-1时表示当前版本没有返回该字段。 failed_lines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successful_lines Long 导入成功行数。其值为-1时表示当前版本没有返回该字段。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
  • 响应示例 状态码: 200 OK { "count" : 2, "failure_jobs" : [ { "job_status" : "FAIL", "resource_id" : "17984002-ad8a-438b-8ba6-b850224634c5", "resource_name" : "Protected-Instance-ab14", "resource_type" : "protectedInstance", "failure_status" : "createFail", "job_id" : "ff808082686f229a0168707beaab014e", "job_type" : "createProtectedInstance", "begin_time" : "2019-01-21T12:56:35.754Z", "error_code" : "EVS.2024", "fail_reason" : "SdrsGenerateNativeServerParamsTask-fail:volume is error!" }, { "job_status" : "FAIL", "resource_id" : "897f57b2-6e94-4179-b414-9532726c59f2", "resource_name" : "Protected-Instance-5e2e", "resource_type" : "protectedInstance", "failure_status" : "createFail", "job_id" : "ff808082686f229a0168707b9be9013e", "job_type" : "createProtectedInstance", "begin_time" : "2019-01-21T12:56:15.591Z", "error_code" : "EVS.2024", "fail_reason" : "SdrsGenerateNativeServerParamsTask-fail:volume is error!" } ]}
  • 状态码 状态码 描述 200 OK 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 407 Proxy Authentication Required 408 Request Timeout 409 Conflict 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 failure_jobs Array of FailureJobParams objects 失败任务信息列表。 count Integer 列表中失败任务个数。 表5 FailureJobParams 参数 参数类型 描述 job_type String 任务名称。 job_status String 任务状态。当前仅支持“FAIL”。FAIL:表示任务失败。 枚举值: FAIL begin_time String 任务操作时间。默认格式为:"yyyy-MM-ddTHH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。 job_id String 任务id。执行异步API命令下发成功的返回参数。 failure_status String 失败任务状态。createFail:表示创建失败。deleteFail:表示删除失败。attachFail:表示挂载失败。detachFail:表示卸载失败。expandFail:表示扩容失败。resizeFail:表示变更规格失败。startFail:表示开启保护失败。stopFail:表示停止保护失败。reverseFail:表示切换失败。failoverFail:表示故障切换失败。reprotectFail : 表示重保护失败。 枚举值: createFail deleteFail attachFail detachFail expandFail resizeFail startFail stopFail reverseFail failoverFail reprotectFail resource_id String 资源ID。 resource_name String 资源名称。 error_code String 任务失败错误码。 fail_reason String 任务失败原因。 resource_type String 资源类型。 server_groups:表示保护组。 protected_instances:表示保护实例。 replications:表示复制对。 disaster_recovery_drills:表示容灾演练。 枚举值: server_groups protected_instances replications disaster_recovery_drills 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表7 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表9 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表11 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 404 表12 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表13 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 405 表14 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表15 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 406 表16 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表17 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 407 表18 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表19 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 408 表20 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表21 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 409 表22 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表23 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 500 表24 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表25 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 501 表26 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表27 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 502 表28 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表29 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 503 表30 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表31 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码 状态码: 504 表32 响应Body参数 参数 参数类型 描述 error ErrorInfo object 失败返回结构 表33 ErrorInfo 参数 参数类型 描述 message String 错误信息 code String 错误码
  • URI GET /v1/{project_id}/task-center/failure-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 failure_status 否 String 失败任务状态。createFail:表示创建失败。deleteFail:表示删除失败。attachFail:表示挂载失败。detachFail:表示卸载失败。expandFail:表示扩容失败。resizeFail:表示变更规格失败。startFail:表示开启保护失败。stopFail:表示停止保护失败。reverseFail:表示切换失败。failoverFail:表示故障切换失败。reprotectFail : 表示重保护失败。 枚举值: createFail deleteFail attachFail detachFail expandFail resizeFail startFail stopFail reverseFail failoverFail reprotectFail limit 否 Integer 每次请求返回结果个数限制。取值范围为[0,1000]的正整数,默认值为1000。 最小值:0 最大值:1000 缺省值:1000 offset 否 Integer 每次请求开始的下标,即偏移量,默认值为0。offset必须为数字,不能为负数。 最小值:0 缺省值:0 resource_name 否 String 保护组资源名称。 resource_type 否 String 资源类型。server_groups:表示保护组。protected_instances:表示保护实例。replications:表示复制对。disaster_recovery_drills:表示容灾演练。 枚举值: server_groups protected_instances replications disaster_recovery_drills server_group_id 否 String 保护组ID。