云服务器内容精选

  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码: 400 失败响应示例 HttpStatusCode: 400 { "errorMessage": "Graph [ {project_id} -movie1] does not exist, please check project_id and graph_name.", "errorCode": "GES.8000", "result": "failed" }
  • 请求示例 请求示例1:取消已经提交的某个作业。 DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id} 请求示例2:取消全部排队中的作业。 DELETE http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/jobs SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • URI GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 offset 否 Integer 本次查询偏移量,默认为0。 job_id 是 String Response对应的任务Job ID。 limit 否 Integer 本次查询返回最大数量(最大100000),默认为100000。
  • 响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 result String 查询成功时值为success,失败时值为failed。 jobs Object 查询成功时包含jobs字段,jobs字段中包含系统中保存的job状态列表,单个job的状态结构如表3。 表3 job状态结构 参数 类型 说明 jobId String Job名称。 rawRequest String 原始请求Body体 taskType String 任务类型。 canStop Boolean 任务能否被停止。 progress Integer 任务进度,取值范围[0,100]。 startTime String 起始时间,Date型字符串或时间戳。 endTime String 终止时间,Date型字符串或时间戳。 status String Job执行状态,取值为pending/running/complete。 failReason String 失败原因,当status为failed时才有。 files Object 导入文件列表,当taskType为ImportGraph时才有。
  • 响应示例 状态码: 200 成功响应示例 { "jobs": [ { "jobId": "b236a002-6acb-40cd-acca-bc3eb96b807d001680206", "rawRequest": "{\"algorithmName\":\"shortest_path\",\"parameters\":{\"source\":\"0000\",\"target\":\"38\"}}", "taskType": "Algorithm", "canStop": false, "progress": "100", "startTime": "2024-05-23 09:54:00", "failReason": "Running algorithm [shortest_path] error: parameter [source] is invalid!", "endTime": "2024-05-23 09:54:00", "status": "failed" }, { "jobId": "5a39d9f6-e955-4294-8ec6-2fe18eee98c7001680206", "rawRequest": "{\"algorithmName\":\"shortest_path\",\"parameters\":{\"source\":\"46\",\"target\":\"38\"}}", "taskType": "Algorithm", "canStop": false, "progress": "100", "startTime": "2024-05-23 09:41:40", "endTime": "2024-05-23 09:41:40", "status": "success" }, { "jobId": "cef6ae30-f21b-4a2a-a83c-cf91bee679d9001680206", "rawRequest": "", "taskType": "ImportGraph", "canStop": false, "progress": "100", "files": [ { "edgeFiles": [ { "fileName": "/root/ges-install/auDatas/ranking_edge.csv", "totalLines": 1659, "startTime": 1716428001745772, "successfulLines": 1659, "endTime": 1716428001757920, "status": "success", "failedLines": 0 } ] }, { "vertexFiles": [ { "fileName": "/root/ges-install/auDatas/movies_vertex_new.csv", "totalLines": 146, "startTime": 1716428001656072, "successfulLines": 146, "endTime": 1716428001659352, "status": "success", "failedLines": 0 } ] }, { "schemaFiles": [ { "totalLabels": 49, "fileName": "/root/ges-install/auDatas/schema.xml.bak", "failedLabels": 0, "startTime": 1716428001563921, "successfulLabels": 49, "endTime": 1716428001655884, "status": "success" } ] } ], "startTime": "2024-05-23 09:33:21", "endTime": "2024-05-23 09:33:21", "status": "success" } ], "jobCount": 3 }
  • 响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 { "status": "SUC CES S", "entities": { "sub_jobs_total": 1, "sub_jobs": [ { "status": "SUCCESS", "entities": { "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" }, "job_id": "2c9eb2c5544cbf6101544f0635672b60", "job_type": "baremetalSingleCreate", "begin_time": "2019-04-25T20:04:47.591Z", "end_time": "2019-04-25T20:08:21.328Z", "error_code": null, "fail_reason": null } ] }, "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", "job_type": "baremetalBatchCreate", "begin_time": "2019-04-25T20:04:34.604Z", "end_time": "2019-04-25T20:08:41.593Z", "error_code": null, "fail_reason": null }
  • 响应参数 参数 参数类型 描述 status String Job的状态。 SUCCESS:成功 RUNNING:运行中 FAIL:失败 INIT:正在初始化 PENDING_PAYMENT:包年/包月订单待支付 entities Object Job操作的对象。请参见表2。 根据不同Job类型,显示不同的内容。裸金属服务器相关操作显示server_id;网卡相关操作显示nic_id;有子Job时为子Job的详情。 job_id String Job ID。 job_type String Job的类型,包含以下类型: baremetalBatchCreate:批量创建裸金属服务器 baremetalBatchOperate:批量修改裸金属服务器电源状态 baremetalVolumeBootReinstallOs:重装快速发放裸金属服务器操作系统 baremetalReinstallOs:重装本地盘裸金属服务器操作系统 baremetalAttachVolume:挂载单个磁盘 baremetalDetachVolume:卸载单个磁盘 begin_time String 开始时间。 时间戳格式为ISO 8601,例如:2019-04-25T20:04:47.591Z end_time String 结束时间。 时间戳格式为ISO 8601,例如:2019-04-26T20:04:47.591Z error_code String Job执行失败时的错误码。 fail_reason String Job执行失败时的错误原因。 message String 出现错误时,返回的错误消息。 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考状态码。 表2 entities字段数据结构说明 参数 参数类型 描述 sub_jobs_total Integer 子任务数量。没有子任务时为0。 sub_jobs Array of objects 每个子任务的执行信息。没有子任务时为空列表。请参见表3。 表3 sub_jobs字段数据结构说明 参数 参数类型 描述 status String Job的状态。 SUCCESS:成功 RUNNING:运行中 FAIL:失败 INIT:正在初始化 entities Object Job操作的对象。根据不同Job类型,显示不同的内容。裸金属服务器相关操作显示server_id;网卡相关操作显示nic_id。 请参见表4。 job_id String Job ID。 job_type String Job的类型,包含以下类型: baremetalSingleCreate:创建单个裸金属服务器 baremetalSingleOperate:修改单个裸金属服务器电源状态 begin_time String 开始时间。 时间戳格式为ISO 8601,例如:2019-04-25T20:04:47.591Z end_time String 结束时间。 时间戳格式为ISO 8601,例如:2019-04-26T20:04:47.591Z error_code String Job执行失败时的错误码。 fail_reason String Job执行失败时的错误原因。 message String 出现错误时,返回的错误消息。 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考状态码。 表4 entities字段数据结构说明 参数 参数类型 描述 server_id String 裸金属服务器相关操作显示server_id。 nic_id String 网卡相关操作显示nic_id。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "data": { "outputs": { "data_return_size": 2, "vertices": [ { "id": "Sarah", "label": "user", "properties": { "Occupation": [ "other or not specified" ], "Name": [ "莎拉" ], "Zip-code": [ "55105" ], "Gender": [ "F" ], "Age": [ "18-24" ] } }, { "id": "Sidney", "label": "user", "properties": { "Occupation": [ "writer" ], "Name": [ "西德尼" ], "Zip-code": [ "85296" ], "Gender": [ "M" ], "Age": [ "18-24" ] } } ], "data_offset": 0, "data_total_size": 19 } }, "status": "success" }
  • URI GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 job_id 是 String Job ID offset 否 Integer 本次查询偏移量,默认为0。 limit 否 Integer 本次查询返回最大数量(最大100000),默认为100000。
  • 响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 status String 查询成功时返回任务状态,包括以下四种状态: pending:等待中。 running:运行中。 success:成功。 failed:失败。 查询失败时字段为空。 data Object 算法运行的结果。查询失败时字段为空。 表3 data参数说明 参数 类型 说明 vertices List 点上关联的算法结果。 edges List 边上关联的算法结果。 outputs Object 其他输出结果。 data_return_size Integer 本次查询返回结果数量。 data_offset Integer 本次查询返回结果偏移量。 data_total_size Integer 异步任务产生的结果数据总量。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorMessage": "can not find job to cancel, id is 9440a7ebXXXXXXXXXXXXXXXXXXXX2d079a67001679122", "errorCode": "GES.8303" }
  • 响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 result String 查询成功时值为success,失败时值为failed。 jobs Object 查询成功时包含jobs字段,jobs字段中包含系统中保存的job状态列表,单个job的状态结构如表3。 表3 job状态结构 参数 类型 说明 jobId String Job名称。 request Object 请求内容,包括command、url和body体。 status String Job执行状态,取值为pending/running/complete。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "jobs": [ { "jobId": "62582163123991943683d0f9aa3-f701-48be-a662-360e6a0455da", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } }, { "jobId": "62582163123991943683fe74caf-f4d3-48b3-b3ee-66daaedcd2ca", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } }, { "jobId": "6258216312399194368daa80df3-e3bd-440d-9764-74f4622a550f", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } }, { "jobId": "62582163123991943680ed2761f-01f7-4fbf-b867-0a9aae6d9c12", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } } ], "result": "success" } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph : movidde not exist", "errorCode": "GES.8000", "result": "failed" }
  • 响应示例 状态码: 200 OK { "status" : "SUCCESS", "entities" : { "server_group_id" : "a59d008e-4bad-4bf3-9b17-6cc25e7da483" }, "job_id" : "0000000062db92d70162db9d200f000a", "job_type" : "createProtectionGroupNoCG", "begin_time" : "2018-04-19T01:55:30.443Z", "end_time" : "2018-04-19T01:55:45.493Z", "error_code" : null, "fail_reason" : null}
  • 状态码 状态码 描述 200 OK 400 Bad Request 401 Unauthorized 403 Forbidden 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