云服务器内容精选

  • 接口说明 1.24.100以前版本的多维视图&多维分支相关接口将于2025年01月起逐步下线。如果您的系统正在调用1.24.100以前版本接口,请尽快更新至1.24.100版本接口,避免因相关接口下线而导致系统不可用。 1.24.100以前版本的多维视图&多维分支相关接口包括:getAllVersions、logicalDeleteLatestVersion、deleteLatestVersion、getVersionByMaster、batchUpdateVersion、compareBusinessVersion、deleteBranch、logicalDeleteBranch、batchDeleteBranch、batchLogicalDeleteBranch、batchDelete、batchLogicalDelete、logicalDelete、delete和createView。
  • 示例代码对比 本章节以createView/createViewV2接口为例。 表1 示例代码对比 1.24.100以前版本 1.24.100版本 public void test() { // 创建VersionViewCreateDTO公共父类的dto对象 VersionViewCreateDTO dto = new VersionViewCreateDTO(); dto.setVersionId(1L); cbmvFuntionTest01Delegator.createView(dto); } public void test() { // 创建CBMVFuntionTest01VersionViewCreateDTO子类的dto对象 CBMVFuntionTest01VersionViewCreateDTO dto = new CBMVFuntionTest01VersionViewCreateDTO(); dto.setVersionId(1L); cbmvFuntionTest01Delegator.createViewV2(dto); }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 job_id String 扩副本任务ID。请求失败时字段为空。 说明: 可以查询jobId查看任务执行状态、获取返回结果,详情参考任务中心API。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口,响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 expand 是 expand object expand是一个对象 表4 expand 参数 是否必选 参数类型 描述 replication 是 Integer 新扩副本数量。
  • 请求示例 请求示例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使用限制。
  • 响应示例 状态码: 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" }
  • 响应参数 表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 }
  • 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。
  • 删除API 在 DataArts Studio 控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。 在左侧导航栏选择服务版本(例如:专享版),进入总览页。 在左侧选择“API目录”,进入API列表页,勾选需要删除的API,单击“删除”。 只有未发布状态(如已创建、已下线)的API可以删除,已停用或发布状态不可删除。 批量删除API最多同时删除1000个API。 单击“确定”,完成API删除。
  • API网关运行时可获取变量 表2 网关错误响应消息体支持的变量 运行时变量名称 描述 $context.apiId API的ID $context.apiName API名称 $context.appId API调用者的凭据对象ID $context.appName API调用者的凭据对象名称 $context.requestId 当次API调用生成请求ID $context.stage API调用的部署环境 $context.sourceIp API调用者的源地址 $context.reqPath API请求路径,不包含query参数 $context.reqUri API请求路径,包含query参数 $context.reqMethod API请求方法 $context.authorizer.frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context.error.code 当前网关错误响应的错误码 $context.error.type 当前网关错误响应的错误类型
  • 网关错误响应类型说明 API网关提供的错误响应类型见下表,其中响应状态码可以按实际需要做自定义修改。 表1 API网关的错误响应类型 错误说明 默认的响应状态码 详细说明 拒绝访问 403 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 自定义认证配置错误 500 自定义认证方异常,通信失败、返回异常响应等错误 自定义认证失败 500 自定义认证方返回认证失败 自定义认证身份来源错误 401 前端自定义认证的身份来源信息缺失或不合法错误 第三方认证配置错误 500 第三方认证方异常,通信失败、返回异常响应等错误 第三方认证失败 401 第三方认证方返回认证失败 第三方认证身份来源错误 401 第三方认证的身份来源信息缺失 认证失败 401 认证失败, IAM 或APP认证校验失败 认证身份来源缺失 401 认证身份来源信息缺失 后端超时 504 后端超时,与后端的网络交互超过预配置的时间错误 后端不可用 502 后端不可用,网络不可达错误 默认4XX - 其它4XX类错误 默认5XX - 其它5XX类错误 未找到匹配的API 404 未匹配到API 请求参数错误 400 请求参数校验失败、不支持的HTTP方法 调用次数超出阈值 429 API调用次数超出所配置的流量策略阈值 凭据未授权 401 使用的凭据未被授权访问该API
  • 响应示例 状态码: 200 成功响应示例 { "encrypted" : false, "ges_metadata" : { "labels" : [ { "name" : "friends" }, { "name" : "movie", "properties" : [ { "data_type" : "string", "name" : "ChineseTitle", "cardinality" : "single" }, { "data_type" : "int", "name" : "Year", "cardinality" : "single" }, { "data_type" : "string", "name" : "Genres", "cardinality" : "set" } ] }, { "name" : "user", "properties" : [ { "data_type" : "string", "name" : "ChineseName", "cardinality" : "single" }, { "type_name1" : "F", "type_name2" : "M", "data_type" : "enum", "name" : "Gender", "type_name_count" : "2", "cardinality" : "single" }, { "type_name1" : "Under 18", "type_name2" : "18-24", "type_name3" : "25-34", "type_name4" : "35-44", "type_name5" : "45-49", "type_name6" : "50-55", "type_name7" : "56+", "data_type" : "enum", "name" : "Age", "type_name_count" : "7", "cardinality" : "single" }, { "data_type" : "string", "name" : "Occupation", "cardinality" : "single" }, { "data_type" : "char array", "name" : "Zip-code", "max_data_size" : "12", "cardinality" : "single" } ] }, { "name" : "rate", "properties" : [ { "data_type" : "int", "name" : "Score", "cardinality" : "single" }, { "data_type" : "date", "name" : "Datetime", "cardinality" : "single" } ] } ] } } 状态码: 400 失败响应示例 { "error_msg" : "6b74069d-3cf3-4cc0-9118-2478e23b87a does not exist.", "error_code" : "GES.2067" }
  • URI POST /v1.0/{project_id}/graphs/{graph_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 action_id 是 String 图actionId。 枚举值: stop
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 jobId String 关闭图任务ID。请求失败时为空。 说明: 可以查询jobId查看任务执行状态、获取返回结果,详情参考任务中心API。