华为云用户手册

认证证书 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。华为云还提供以下资源来帮助用户满足合规性要求。 行业 合规性说明 ISO/IEC 华为云 ISO/IEC 27001 合规性说明 HIPAA 华为云 HIPAA 合规性说明 LGPD 巴西LGPD合规性说明 PDPA 马来西亚PDPA合规性说明 新加坡PDPA合规性说明 泰国 PDPA 合规性说明 中国澳门PDPA 合规性说明 PCI DSS 华为云 PCI DSS 实践指南 PDPO 中国香港PDPO 合规性说明 POPIA 南非 POPIA 合规性说明 CS A CSA CCM 合规性说明（CSA CAIQ v3.1） PDPL 阿根廷 PDPL 合规性说明 MPA MPA 合规性说明通用指南 MPA 合规性说明——应用程序及云端分布式环境安全指南 金融行业 新加坡金融行业监管要求合规性说明 中国香港金融行业监管要求合规性说明 泰国金融行业监管遵从性指导 马来西亚金融行业监管遵从性指导 巴西金融行业监管遵从性指导 阿根廷金融行业监管遵从性指导 南非金融行业监管遵从性指导 证券及期货 中国香港证券及期货行业监管遵从性指导 保险 中国香港保险行业监管遵从性指导 隐私 印尼隐私合规性说明 另外，华为云还提供了以下销售许可证及软件著作权证书，供用户下载和参考。 销售许可证 云堡垒机 CBH DDoS防护 ADS Web应用防火墙 WAF 企业主机安全 HSS 数据库安全 DBSS 软件著作权证书 态势感知 SA 企业主机安全 HSS 容器安全 CGS DDoS防护 ADS Web应用防火墙 WAF 漏洞扫描服务 VSS 数据库安全 DBSS 数据安全中心 DSC 数据加密 服务 DEW - 父主题： 安全

产品功能 支持自动化编排资源 AOS提供自动化的编排能力，支持编排华为云主流云服务，具体请参见支持编排的云服务。AOS还提供资源规划、应用设计、部署、变更等生命周期管理等相关服务，通过自动化降低运维成本。 支持应用与云服务资源混合编排 您可通过标准语言（YAML/JSON）统一描述所需基础资源、应用系统、应用上层配套服务及三者之间的关系。根据统一描述，可一键式按照定义的依赖顺序，自动完成资源开通、应用部署、应用服务加载。对于部署的资源和应用，可以统一的进行管理：删除、扩缩容、复制、迁移等。

批量创建 应用场景： 如果您需要创建一个包含10个不同规格的弹性云服务器实例的Web应用，或者您需要一次创建10个数据库实例时，您需要一个个单独创建这些资源，然后必须将这些资源配置为结合使用，才能确保应用顺利启动，增加了使用云资源的复杂性和时间成本。 价值： 应用编排服务 将大批量的、不同服务、不同规格的资源实例，统一定义在模板中，一键完成创建，实现资源的快速部署和灵活配置。 优势： 快速部署 通过应用编排服务自动化并发创建多个云服务资源，或不同规格的同一服务资源。 灵活配置 丰富的模板语法，支持根据不同场景灵活配置创建资源的种类与规格。 自动回退 批量创建过程中如果失败，用户可选择自动回退，以节省资源成本。 图3 批量创建场景

应用上云 应用场景： 应用上云时，很多工作需要重复操作，例如环境的销毁和重建、在扩容的场景下重复完成多个新实例的配置等。同时应用上云时，很多操作非常耗时，例如创建数据库、创建虚拟机等，都需等待分钟级别的时间。一旦需要串行创建多个耗时任务，就需要您持续等待一段时间。而此时如果可以将整个流程自动化，可以减少您的等待过程，完成其他更有价值的任务。 价值： 使用应用编排服务，通过模板对应用及应用所需资源进行统一描述，一键式自动完成部署或销毁操作。您可以同步进行资源规划、应用定义和业务部署，提升应用上云的效率。 优势： 简单易用 通过编写模板，即可完成应用设计与资源的规划，使业务的组织和管理变得轻松。 高效执行 一键式自动完成部署或销毁操作，省去繁琐的人工操作。 快速复制 同一模板可以多次重复使用，自动化构建相同的应用与资源到不同的数据中心。 图1 应用上云场景

ISV业务发放 应用场景： 独立软件开发商（ISV）需要让客户快速将软件服务部署到云上，供其自身的客户进行使用。ISV传统的软件发放的方式是在其官网提供软件的代码下载及平台搭建指南。但该方式需要客户自建资源与组网，准备时间长，成本高。并且安装过程完全手动，耗时易出错，软件的版本更新都需要客户自己手动操作，运维压力大。 价值： 应用编排服务的模板提供了标准化的资源和应用交付方式。ISV可以通过将软件服务模板化，通过应用编排服务的一键部署能力，对自身客户进行业务发放。 优势： 快速发放 通过模板，自动化完成软件的部署与资源的开通，用户只需一键部署，分钟级完成。 准确创建 ISV软件本身及所需的云服务资源都通过模板固化，减少人工失误带来的影响。 统一维护 软件的生命周期管理可以统一通过AOS服务实现，一键完成软件的升级、伸缩等操作。 图2 ISV业务发放场景

责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的 云安全 挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的 IaaS、PaaS 和 SaaS 各类各项云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括运维运营安全，以及更广义的安全合规遵从。 租户：负责云服务内部的安全，安全地使用云。 华为云租户的安全责任在于对使用的 IaaS、PaaS 和 SaaS 类各项云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、 虚拟主机 和访客虚拟机的操作系统，虚拟防火墙、API 网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施，包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。 图1 华为云安全责任共担模型 父主题： 安全

简单易用的编排语言 AOS编排语言支持 YAML和JSON 语法来定义需要的元素。 AOS编排语言支持参数化，您只需更改输入参数，即可控制要部署对象的规格、实例数量以及执行的操作，从而实现模板的重复利用。 AOS编排语言支持变量引用，包括引用输入参数、引用元素属性和引用映射表。 引用输入参数：获取模板文件中inputs区域中定义的输入参数的值。 引用元素属性：获取模板中定义的其他元素初始化后的结果。例如新建了一个虚拟私有云，再新建弹性云服务器时，可使用已新建的虚拟私有云ID。该方法可用于构建资源间依赖关系并控制资源的创建顺序。 引用映射表：用于获取映射表中的内容。

ISV资源发放 场景描述 独立软件开发商(ISV)需要快速将软件所需资源部署到云上，供其众多的客户进行使用。传统的软件发放的方式是在其官网提供软件的代码下载及平台搭建指南。但该方式需要ISV自行组网、交付资源、部署软件，准备时间长，成本高。 解决方案 资源编排 提供了标准化的资源和应用交付方式。ISV可以通过将软件服务模板化。通过资源编排的资源栈部署能力，对自身客户进行快速业务发放，将交付过程流程化。资源编排使用代码形式模板描述整个交付环境，也便于ISV将交付与CI/CD流程集成。 收益优势： 交付标准化 通过模板、资源栈方式将软件交付过程标准化，便于总结成最佳实践以便推广。 提升效率 通过模板，自动化完成资源的开通，ISV只需部署资源栈，即可完成业务的交付；提升了ISV的交付效率。 准确创建 ISV的软件本身及所需的云服务资源都通过模板固化，减少人工失误带来的影响。 CI/CD集成 可以将资源编排集成到现有工具链中，提升自动化程度。 图2 ISV资源发放场景

应用上云 场景描述 应用上云时，很多工作需要手工重复操作，例如环境的销毁和重建、在扩容的场景下重复完成多个新实例的配置等，手工操作容易带来操作失误。 同时应用上云时，很多操作非常耗时，例如创建数据库、创建虚拟机等，手动操作容易失误 ，串行创建多个任务，就需要您持续等待较长时间。 解决方案 资源编排就是将上述场景的工作进行工具化、流程化。资源编排采用模板对应用所需资源进行统一描述；资源栈管理功能提供众多资源自动化部署或销毁操作。资源编排可以将大批量、不同服务、不同规格的资源实例，统一定义在模板中。完成自动化创建，实现资源的快速部署和灵活配置。 收益优势 简单易用 通过编写模板，即可完成应用设计与资源的规划，使业务的组织和管理变得轻松。 高效执行 向导式自动完成部署或销毁操作，省去繁琐的人工操作，减少了人为操作的失误 。 快速复制 同一模板可以多次重复使用，自动化构建相同的应用与资源到不同的数据中心。提升了您的工作效率。

审计与日志 审计 云审计 服务（Cloud Trace Service， CTS ），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 AOS支持审计的操作事件，请参见云审计服务支持的AOS操作列表。 日志 用户开通云审计服务并创建和配置追踪器后，CTS可记录与AOS相关的操作事件，方便您进行事后审计。您可以在CTS控制台，事件列表菜单中，搜索AOS的事件来源，即可查看所有AOS相关的审计日志。 审计日志查看方法，请参见查看云审计日志。 父主题： 安全

支持Provider版本列表 支持Provider版本列表 Provider是将各类资源的API（比如资源的CRUD操作API）封装而成的插件，供资源编排引擎调用。资源编排支持Provider类型与版本如下表。 类型 版本 terraform-provider-huaweicloud 1.40.2 1.40.1 1.40.0 1.39.0 1.38.2 1.38.1 terraform-provider-kubernetes 2.5.0 父主题： 资源编排

排查思路 在访问控制日志中，搜索被阻断IP/ 域名 的日志记录。 如有记录，可单击“规则”列跳转至匹配到的阻断策略，后续操作见场景一：防护策略配置错误。 如无记录，执行2。 在攻击事件日志中，搜索被阻断IP/域名的日志记录。 如有记录，可复制“规则ID”列信息，后续操作见场景二：IPS等入侵防御功能的误拦截。 如无记录，执行3。 弹性公网IP管理中关闭了EIP的防护或VPC边界防火墙管理中关闭了防护后，业务恢复正常，则建议您关闭防火墙防护并提交工单咨询。 （可选）为了监测防火墙状态，迅速把握异常情况，推荐您进行如下配置： 在 云防火墙 控制台配置告警通知，请参见告警通知。 在 云监控 控制台配置CFW告警规则，配置方式请参见设置监控告警规则，支持的监控指标请参见CFW监控指标说明。

响应示例 状态码： 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 OK Http Status Code: 200 { "jobId": "ff80808167f09aaa0167f19b35ec0305", "status": "success", "jobType": "GraphManagement", "jobName": "ImportGraph", "relatedGraph": "GES_UI_AUTO", "beginTime": "2018-11-27T21:39:00", "endTime": "2018-11-27T21:39:56", "jobDetail": { "vertexsetPath": [ { "path": "ges-ui/auDatas/list_set_vertex.csv", "log": null, "cause": null, "status": "success" } ], "edgesetPath": [ { "path": "ges-ui/auDatas/list_set_edge.csv", "log": null, "cause": null, "status": "success" } ], "schemaPath": [ { "path": "ges-ui/auDatas/list_set_schema.xml", "log": null, "cause": null, "status": "success" } ] }, "jobProgress": 0 } 状态码： 400 Bad Request { "errorMessage" : "can not find job, jobId is ff808081646e81d40164c5fb414b2b1a1", "errorCode" : "GES.8301" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 任务ID。 status String 任务状态。 pending：等待中。 running：运行中。 success：成功。 failed：失败。 jobType String 任务类型。 jobName String 任务名称。 relatedGraph String 关联图名称。 beginTime String 任务开始时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" endTime String 任务结束时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss" jobDetail JobDetail object 只有jobName为ImportGraph时才返回，用于显示导入图详情。 failReason String 任务失败原因。 jobProgress Double 任务执行进度，预留字段，暂未使用。 表4 JobDetail 参数 参数类型 描述 schemaPath Array of schemaPath objects 元数据路径。 edgesetPath Array of edgesetPath objects 边数据集路径。 vertexsetPath Array of vertexsetPath objects 点数据集路径。 表5 schemaPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 表6 edgesetPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 totalLines Long 导入的总行数，以您的配额以及所创图的规格为准。其值为-1时表示当前版本没有返回该字段。 failedLines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successfulLines Long 导出成功行数。其值为-1时表示当前版本没有返回该字段。 表7 vertexsetPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 totalLines Long 导入总行数。以您的配额以及所创图的规格为准，其值为-1时表示当前版本没有返回该字段。 failedLines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successfulLines Long 导出成功行数。其值为-1时表示当前版本没有返回该字段。

响应示例 状态码： 200 成功响应示例 { "job_count" : 2, "job_list" : [ { "job_id" : "ff80808167bb90340167bc3c7b5b026a", "status" : "success", "job_type" : "GraphManagement", "job_name" : "ImportGraph", "related_graph" : "test1217", "begin_time" : "2018-12-17T12:55:40", "end_time" : "2018-12-17T12:56:32", "job_detail" : { "vertexset_path" : null, "edgeset_path" : [ { "path" : "hkmovie/edge.csv", "log" : null, "cause" : null, "status" : "success" } ], "schema_path" : [ { "path" : "hkmovie/schema.xml", "log" : null, "cause" : null, "status" : "success" } ] }, "job_progress" : 0 }, { "job_id" : "ff80808167bb90340167bc5d0b1d0358", "status" : "success", "job_type" : "GraphManagement", "job_name" : "DeleteGraph", "related_graph" : "test1218", "begin_time" : "2018-12-17T13:31:14", "end_time" : "2018-12-17T13:34:48", "job_progress" : 0 } ] } 状态码： 400 失败响应示例 { "error_msg" : "failed", "error_code" : "GES.9999" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_count Integer 任务总数。 job_list Array of job_list objects 任务列表。 表5 job_list 参数 参数类型 描述 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 任务执行进度，预留字段，暂未使用。 表6 job_detail 参数 参数类型 描述 schema_path Array of schema_path objects 元数据路径。 edgeset_path Array of edgeset_path objects 边数据集路径。 vertexset_path Array of vertexset_path objects 点数据集路径。 表7 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时表示当前版本没有返回该字段。 表8 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时表示当前版本没有返回该字段。 表9 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 表10 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

URI GET /v2/{project_id}/graphs/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号，用于资源隔离。 表2 Query参数 参数 是否必选 参数类型 描述 end_time 否 String 任务结束日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。 graph_name 否 String 关联的图名称。 limit 否 String 每页资源数量的最大值，默认为10。 offset 否 String 本次请求的起始位置，默认为0。 start_time 否 String 任务开始日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。 status 否 String 任务状态。取值为： running waiting success failed

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of results objects scene场景分析插件信息。 表5 results 参数 参数类型 描述 scene String 场景名。 name String application名称。 params Array of params objects 参数列表。 description String 场景下应用的描述。 表6 params 参数 参数类型 描述 name String 参数名称。 type String 参数类型。取值范围["string","int"]，目前仅支持"string" default_value String 取值范围为空，或参数默认值，当为空是表示客户使用时必须传入此参数 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

URI GET /v2/{project_id}/graphs/scenes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 scene_name 否 String 场景名称。当有且只有scene_name有值时，返回对应scene_name下的所有application详情。当有且只有scene_name、application_name有值时，返回与application_name对应的application详情。当scene_name、application_name、graph_id均无值时,返回所有SceneApplication application_name 否 String 应用程序名字。当有且只有scene_name、application_name有值时，返回与application_name对应的application详情。当scene_name、application_name、graph_id均无值时,返回所有SceneApplication。 graph_id 否 String 图ID。 当有且只有graph_id有值时，返回对应图id下所订阅的application详情。 当scene_name、application_name、graph_id均无值时,返回所有SceneApplication。

子图匹配（subgraph_matching）(2.2.16) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 edges 是 需匹配的子图的边集, 点的ID要求为size_t类型 String 标准CSV格式，边的起点与终点之间以英文逗号分隔，各边之间以换行符“\n”分隔，例如：“1,2\n2,3”。 vertices 是 需匹配的子图上各点的label String 标准CSV格式，点与其label之间以英文逗号分隔，各点与其label对之间以换行符“\n”分隔，点与sample中点相对应，例如：“1,BP\n2,FBP\n3,CP”。 directed 否 是否考虑图的方向 Boolean true或false,默认true。 n 否 限制寻找的子图的个数的上限 Integer [1,100000]，默认为100。 batch_number 否 每轮批量处理的个数 Integer [1,1000000]，默认为10000。 statistics 否 是否输出所有满足条件的子图的个数 Boolean true或false,默认false。 表2 response_data 参数说明 参数 是否必选 类型 说明 subgraphs 是 List 与pattern_graph同构的子图。格式: [[subgraph1],[subgraph2],…],其中subgraph的格式为： [vertex1,vertex2,…],其中vertex为string类型， 每个子图的点与pattern_graph的点一一对应。 pattern_graph 是 List 格式为：[vertex1,vertex2,…],其中vertex为string类型。 subgraph_number 否 Integer 当statistics = true时，输出所有满足条件的子图的个数。 父主题： 算法API参数参考

响应示例 状态码： 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 OK Http Status Code: 200 { "jobCount": 136, "jobList": [ { "jobId": "ff80808167bb90340167bc3c7b5b026a", "status": "success", "jobType": "GraphManagement", "jobName": "ImportGraph", "relatedGraph": "test1217", "beginTime": "2018-12-17T12:55:40", "endTime": "2018-12-17T12:56:32", "jobDetail": { "vertexsetPath": null, "edgesetPath": [ { "path": "hkmovie/edge.csv", "log": null, "cause": null, "status": "success" } ], "schemaPath": [ { "path": "hkmovie/schema.xml", "log": null, "cause": null, "status": "success" } ] }, "jobProgress": 0 }, { "jobId": "ff80808167bb90340167bc5d0b1d0358", "status": "success", "jobType": "GraphManagement", "jobName": "DeleteGraph", "relatedGraph": "test1218", "beginTime": "2018-12-17T13:31:14", "endTime": "2018-12-17T13:34:48", "jobProgress": 0 } ] } 状态码： 400 Bad Request { "errorMessage" : "failed", "errorCode" : "GES.9999" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobCount Integer 任务总数。 jobList Array of Job objects 任务列表。 表5 Job 参数 参数类型 描述 jobId String 任务ID。 status String 任务状态。 pending：等待中。 running：运行中。 success：成功。 failed：失败。 jobType String 任务类型。 jobName String 任务名称。 relatedGraph String 关联图名称。 beginTime String 任务开始时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"。 endTime String 任务结束时间，格式为UTC,"yyyy-MM-dd'T'HH:mm:ss"。 jobDetail JobDetail object 只有jobName为ImportGraph时才返回，用于显示导入图详情。 failReason String 任务失败原因。 jobProgress Double 任务执行进度，预留字段，暂未使用。 表6 JobDetail 参数 参数类型 描述 schemaPath Array of schemaPath objects 元数据路径。 edgesetPath Array of edgesetPath objects 边数据集路径。 vertexsetPath Array of vertexsetPath objects 点数据集路径。 表7 schemaPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因 表8 edgesetPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 totalLines Long 导入总行数。其值为-1时表示当前版本没有返回该字段。 failedLines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successfulLines Long 导出成功行数。其值为-1时表示当前版本没有返回该字段。 表9 vertexsetPath 参数 参数类型 描述 path String OBS文件路径。 log String OBS文件导入日志存储文件。 status String OBS文件导入状态。 success：完全成功 failed：完全失败 partFailed：部分成功 cause String 导入失败原因。 totalLines Long 导入总行数。其值为-1时表示当前版本没有返回该字段。 failedLines Long 导入失败行数。其值为-1时表示当前版本没有返回该字段。 successfulLines Long 导出成功行数。其值为-1时表示当前版本没有返回该字段。

URI GET /v1.0/{project_id}/graphs/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 endTime 否 String 任务结束日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。 graph_name 否 String 关联的图名称 limit 否 String 每页资源数量的最大值，默认为10。 offset 否 String 本次请求的起始位置，默认为0。 startTime 否 String 任务开始日期，当前只支持日期，不支持时间。格式为：yyyy-MM-dd，比如2019-03-27。 status 否 String 任务状态。取值为： running waiting success failed

请求示例 请求样例1：列出满足过滤条件的第k跳节点或边，查询类型是出点，作用在下一跳的点上。 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query { "repeat":[ { "operator":"outV", "vertex_filter":{ "property_filter":{ "leftvalue":{ "label_name":"labelName" }, "predicate":"=", "rightvalue":{ "value":"rate" } } } } ], "times":2, "vertices":[ "1","2" ] } 以上请求等价于gremlin语句：g.V('1','2').repeat(out().hasLabel('rate')).times(2).dedup() 请求样例2：列出满足过滤条件的第k跳节点或边，查询类型是出点，作用在下一跳的点上。 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query { "repeat":[ { "operator":"outV", "vertex_filter":{ "property_filter":{ "leftvalue":{ "label_name":"labelName" }, "predicate":"=", "rightvalue":{ "value":"rate" } } } } ], "until":[ { "vertex_filter":{ "property_filter":{ "leftvalue":{ "property_name":"movieid" }, "predicate":"=", "rightvalue":{ "value":"1" } } } } ], "vertices":[ "v1","v2" ] } 以上请求等价于gremlin语句： g.V('v1','v2').repeat(out().hasLabel('rate')).until(has('movieid','1')).dedup()