华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 schema_count Integer 元数据返回个数。请求失败时，字段为空。 schema_list Array of schema_list objects 当前project_id下的所有元数据列表。请求失败时，字段为空。 表5 schema_list 参数 参数类型 描述 id String 元数据 ID。 name String 元数据名称。 start_time String 元数据创建时间。 last_update_time String 元数据最后更新时间。 encrypted Boolean 元数据是否加密。 master_key_name String 秘钥名称。 master_key_id String 秘钥id。 description String 元数据 描述。 metadata_path String 元数据对应路径。 status String 元数据是否可用。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

响应示例 状态码： 200 成功响应示例 { "schema_count" : 2, "schema_list" : [ { "start_time" : "2022-01-21T10:13:31", "last_update_time" : "2022-01-21T10:13:31", "encrypted" : true, "master_key_name" : "Autouse_No_Delete", "name" : "schema_748e", "master_key_id" : "106be30a-733d-45d0-84f3-1c5439381313", "description" : "xxxxx", "id" : "6634c50e-13aa-4395-8088-6b327f7da694", "metadata_path" : "devdata/schema_748e.xml", "status" : "200" }, { "start_time" : "2022-04-12T03:15:17", "last_update_time" : "2022-11-16T08:18:32", "encrypted" : false, "name" : "unionsdk_schema", "id" : "6b74069d-3cf3-4cc0-9118-2478e23b87aa", "metadata_path" : "devdata/unionsdk/unionsdk_schema.xml", "status" : "200" } ] } 状态码： 500 失败响应示例 { "error_code" : "GES.7006", "error_msg" : "The underlying graph engine has internal error." }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 success Array of strings 取消订阅成功的SceneApplication。 failure Array of strings 取消订阅失败的SceneApplication。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 scenes 否 Array of scenes objects 要取消订阅的具体场景列表。 表4 scenes 参数 是否必选 参数类型 描述 name 否 String 场景名。 applications 否 Array of strings 要取消订阅的application 名字列表。

请求示例 取消订阅scenes场景应用分析能力，取消订阅的具体场景名称为12345工单关联分析，取消订阅的application名字列表为"动态高纬关系深度分析"。 POST /v2/{project_id}/graphs/{graph_id}/scenes/unregister { "scenes" : [ { "name" : "12345工单关联分析", "applications" : [ "动态高纬关系深度分析" ] } ] }

响应示例 状态码： 200 成功响应示例 { "backup_count" : 3, "backup_list" : [ { "id" : "ada3e720-ab87-48cb-bff7-3ec5ae1a9652", "name" : "ges060803_nodelete-20210608135513", "backup_method" : "manual", "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name" : "ges060803_nodelete", "graph_status" : "200", "graph_size_type_index" : "1", "data_store_version" : "2.2.21", "arch" : "x86_64", "status" : "success", "start_timestamp" : 1623160513000, "start_time" : "2021-06-08T13:55:13", "end_timestamp" : 1623160568000, "end_time" : "2021-06-08T13:56:08", "size" : 1, "duration" : 54, "encrypted" : false }, { "id" : "7ed3f51d-816d-4651-9129-fe21b64b5c91", "name" : "ges060803_nodelete_20210609203323_auto", "backup_method" : "auto", "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name" : "ges060803_nodelete", "graph_status" : "200", "graph_size_type_index" : "1", "data_store_version" : "2.2.21", "arch" : "x86_64", "status" : "success", "start_timestamp" : 1623242004000, "start_time" : "2021-06-09T12:33:24", "end_timestamp" : 1623242004000, "end_time" : "2021-06-09T12:33:24", "size" : 1, "duration" : 0, "encrypted" : false }, { "id" : "604bfb46-04dd-45fc-a9ae-df24a0705b9d", "name" : "ges060802_nodelete-20210608135523", "backup_method" : "manual", "graph_id" : "9b9a05c2-0cdb-41ac-b55f-93caffb0519a", "graph_name" : "ges060802_nodelete", "graph_status" : "400", "graph_size_type_index" : "0", "data_store_version" : "2.2.23", "arch" : "x86_64", "status" : "success", "start_timestamp" : 1623160524000, "start_time" : "2021-06-08T13:55:24", "end_timestamp" : 1623160577000, "end_time" : "2021-06-08T13:56:17", "size" : 1, "duration" : 53, "encrypted" : false } ] } 状态码： 400 失败响应示例 { "error_code" : "GES.7006", "error_msg" : "The underlying graph engine has internal error." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backup_count Integer 备份总个数。请求失败时，字段为空。 backup_list Array of backup_list objects 当前Project ID下的所有图的备份列表。请求失败时，字段为空。 表5 backup_list 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 backup_method String 备份方法，取值为auto，manual或者import。 graph_id String 备份关联的图ID。 graph_name String 备份关联的图Name。 graph_status String 备份关联的图状态。 graph_size_type_index String 备份关联的图规格。 data_store_version String 备份关联的图版本。 arch String 备份关联的图CPU架构。 status String 备份状态。 backing_up：备份中 success：备份成功 failed：备份失败 start_timestamp Long 备份开始时间戳。 start_time String 备份开始时间。 end_timestamp Long 备份结束时间戳。 end_time String 备份结束时间。 size Long 备份文件大小，单位为MB。 duration Long 备份时间，单位为秒。 encrypted Boolean 是否加密。默认值为"false"，不加密。 true：表示加密。 false：表示不加密。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

业务面API错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。当调用出错时，HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时，可以联系技术人员，并提供错误码，以便我们尽快帮您解决问题。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 GES.8000 Incorrect parameter format. 参数格式错误 检查请求body体是否和文档描述一致。 400 GES.8001 Failed to query graph statistics. 图统计信息查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8002 Graph statistics query error. 图统计信息查询错误 检查token是否过期，重新获取token。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8005 Incorrect parameter. 参数错误 检查URL中的project_id是否正确。 检查请求头是否正确，比如X-Auth-Token是否正确。 400 GES.8006 Invalid resource access. 资源访问不合法 1.AK/SK鉴权方式：需要检查regioncode或者regionname是否正确。 2.Token鉴权方式：需要检查token对应的project是否正确。 400 GES.8007 Invalid token. Token不合法 检查Token是否正确。 400 GES.8008 An error occurs in the underlying authentication system. 底层认证系统出错 请稍后重试或联系技术支持人员。 400 GES.8011 Failed to export a graph. 导出图失败 检查图名是否正确。 查看导出文件路径是否正确。 检查该账号有无OBS写入权限。 400 GES.8012 Failed to clear a graph. 清空图失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8013 Failed to incrementally import data to the graph. 增量导入图失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8020 The current user does not have permission. （细粒度授权时）当前用户没权限 使用具有Security Administrator权限的用户进行授权。 400 GES.8101 Invalid filter criteria for edge queries. 边过滤查询条件不合法 检查边过滤条件格式是否正确。 400 GES.8102 Invalid label for edge filtering queries. 边过滤查询Label不合法 检查labels是不是正常的josn体。 400 GES.8103 Both the condition and label of edge filtering queries are empty. 边过滤查询条件和Label同时为空 边过滤查询条件和Label不能同时为空。 400 GES.8104 Invalid edge filtering query sequence. 边过滤排序输入不合法 检查边过滤排序输入是否合法。 400 GES.8105 Failed to query edges that meet filter criteria. 边过滤查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8106 The source vertex or target vertex in the edge details is empty. 边详情起点或终点为空 边详情起点和终点不能为空。 400 GES.8107 Failed to query edge details. 边详情查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8108 Edge details query error. 边详情查询内部错误 请稍后重试或联系技术人员。 400 GES.8109 Invalid edge filtering query operator. 边过滤查询算子不合法 边过滤查询算子取值为 in、out、both、edge。 400 GES.8110 Parameter edges cannot be left blank. 参数edges不能为空 批量边查询请求体中edges是否为空。 400 GES.8201 Invalid label for vertex filtering queries. 点过滤查询Label不合法 检查labels是不是正常的josn体。 400 GES.8202 Invalid filter criteria for vertex queries. 点过滤查询条件不合法 检查点过滤查询API中propertyName（属性名称）是否为空。 检查点过滤查询API中values（属性值）是否为空。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8203 Both the condition and label of vertex filtering queries are empty. 点过滤查询条件和Label同时为空 点过滤条件和Label不能同时为空。 400 GES.8204 Failed to query vertices that meet filter criteria. 点过滤查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8205 Invalid vertex filtering query sequence. 点过滤排序输入不合法 点过滤查询API中orderValue必须在“incr”和“decr”。 400 GES.8206 Both vertexid and vertextids exist. vertexid和vertextids同时存在 vertexid和vertextids不能同时存在。 400 GES.8207 Both vertexid and vertextids are empty. vertexid和vertextids同时为空 vertexid或vertextids为空。 400 GES.8208 Incorrect vertextids format. vertextids格式错误 vertextids是否 json array。 400 GES.8209 Failed to query vertex details. 点详情查询失败 检查图名是否存在。 500 GES.8210 Vertex details query error. 点详情查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8211 Invalid vertex filtering query operator. 点过滤查询算子不合法 点过滤查询算子取值为 inV、outV、bothV、vertex。 400 GES.8212 Failed to delete the vertex label. 删除点Label失败 Label是否存在。 400 GES.8213 Failed to add the vertex label. 增加点Label失败 Label是否存在。 400 GES.8214 Parameter vertices cannot be left blank. 参数vertices不能空 批量点查询请求体中vertices是否为空。 400 GES.8220 Failed to update the vertex properties. 更新点属性失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8221 Failed to update the edge properties. 更新边属性失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8301 Failed to query a job. 作业查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8302 Job query error. 作业查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8303 Failed to terminate a job. 作业终止失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8304 Job termination error. 作业终止内部错误 请稍后重试或联系技术支持人员。 400 GES.8401 The algorithm or graph name cannot be empty. 算法名或者图名不能为空 算法名或者图名不能为空。 400 GES.8402 Failed to run the algorithm. 算法执行失败 网络波动问题建议重试下。 检查执行算法API图名是否填写正确。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8403 Algorithm running error. 算法执行内部错误 请稍后重试或联系技术支持人员。 400 GES.8404 Invalid algorithm running format. 算法执行模式不合法 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8501 The Gremlin command is not supported. Gremlin查询命令不支持 不支持Gremlin的tryNext、explain、tree语句。 400 GES.8502 Failed to find the Gremlin configuration file. Gremlin配置文件找不到 请稍后重试或联系技术支持人员。 400 GES.8503 Gremlin query failed. Gremlin查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 500 GES.8504 Gremlin query error. Gremlin查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8505 The Gremlin query statement does not contain the command field. Gremlin查询语句没有command字段 Gremlin查询语句没有command字段。 400 GES.8506 The size of the Gremlin query request statements exceeds the upper limit. Gremlin查询请求语句超过限制 当前限制为64MB。 500 GES.8601 Gremlin service unavailable. Gremlin服务不可用 请稍后重试或联系技术支持人员。 500 GES.8602 Engine service unavailable. Engine服务不可用 请稍后重试或联系技术支持人员。 400 GES.8603 Failed to create an index 索引创建失败 检查索引名称是否只包含字母,数字,-和_。 检查索引参数类型是否符合GES API规定的格式。 400 GES.8604 Failed to delete an index 索引删除失败 检查图名是否填写正确。 检查索引名称是否填写正确。 检查请求Method type是否为delete。 400 GES.8605 Failed to query an index 索引查询失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8609 The request body for querying path details is invalid. 查询路径详情请求体不合法 检查图名是否填写正确。 检查查询路径详情API参数格式是否填写正确。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8610 The path parameter of the request body for querying path details is invalid. 查询路径详情请求体path参数不合法 检查查询路径详情API参数格式是否填写正确。 检查查询路径详情API必选参数是否缺失。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8611 Failed to query path details. 查询路径详情失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8612 The operation of querying path details is not supported. 查询路径详情操作不支持 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 400 GES.8801 Failed to add a label to metadata. 元数据添加label失败 检查要添加的label是否已经存在。 检查添加labelAPI参数格式是否正确。 检查添加labelAPI必选参数是否都有值。 400 GES.8803 Failed to query the metadata. 元数据查询失败 检查要查询的图是否存在。 检查查询图元数据详情API的graph_name是否填写正确。 500 GES.8804 Metadata query error. 元数据查询内部错误 请稍后重试或联系技术支持人员。 400 GES.8806 K-Hop query with filter criteria failed. 带过滤的khop查询执行失败 网络波动问题建议重试下。 若继续失败，则根据errorMessage查看错误信息联系技术支持人员。 父主题： 错误码

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 执行异步任务的JobID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

请求URI 图引擎服务业务面API请求URI由如下部分组成。 {URI-scheme} :// {SERVER_URL} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 SERVER_URL：图的访问地址，取值请参考业务面API使用限制。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如“ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

请求消息头 附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 表1 公共请求消息头 参数名 是否必选 说明 示例 Content-Type 是 消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 application/json X-Auth-Token 是 用户Token。例如， IAM 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 - X-Language 是 请求语言。支持配置如下值： zh-cn：中文 en-us：英文 en-us

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于IAM获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称。例如cn-north-1，可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见IAM获取用户Token。 POST https: //iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于IAM获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

最短路径（shortest_path）(2.1.5) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 source 是 输入路径的起点ID。 String - - target 是 输入路径的终点ID。target取值不能与source取值相同。 String - - weight 否 边上权重。 String 空或字符串。 空：边上的权重、距离默认为“1”。 字符串：对应的边上的属性将作为权重，当某边没有对应属性时，权重将默认为1。 说明： 边上权重应大于0。 - directed 否 是否考虑边的方向。 Boolean true或false。 false timeWindow 否 用于进行时间过滤的时间窗 Object 具体请参见表2。 说明： timeWindow目前不支持带weight的最短路，即timeWindow与weight不可同时输入。 - 表2 timeWindow参数说明 参数 是否必选 说明 类型 取值范围 默认值 filterName 是 用于进行时间过滤的时间属性名称 String 字符串：对应的点/边上的属性作为时间 - filterType 否 在点或边上过滤 String V：点上 E：边上 BOTH：点和边上 BOTH startTime 否 起始时间 String Date型字符串或时间戳 - endTime 否 终止时间 String Date型字符串或时间戳 - 表3 response_data参数说明 参数 类型 说明 path List 最短路径，格式： [vertexId,...] 其中, vertexId：string类型 source String 起点ID target String 终点ID 父主题： 算法API参数参考

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas quotas Object resource类型列表，请求失败时该字段为空。 表4 quotas 参数 参数类型 描述 resources Array of resources objects GES资源配额列表。 表5 resources 参数 参数类型 描述 type String 类型。 取值范围： "graph" "backup" "metadata" available Integer 图的可用个数。 edge_volume Integer 边的可用个数。type为graph时此值有效。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。

响应示例 状态码： 200 成功响应示例 { "quotas" : { "resources" : [ { "type" : "graph", "available" : 10, "edge_volume" : 7300 }, { "type" : "backup", "available" : 100 }, { "type" : "metadata", "available" : 86 } ] } } 状态码： 400 失败响应示例 { "error_code" : "GES.7006", "error_msg" : "An internal error occurs in the underlying service of the graph engine." }

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于IAM获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称。例如cn-north-1，可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见IAM获取用户Token。 POST https: //iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于IAM获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 表1 公共请求头 参数 是否必选 说明 示例 Content-Type 是 消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 application/json X-Auth-Token 使用Token方式认证时必选 用户Token。例如，IAM用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 - X-Project-ID 否 子项目ID。在多项目场景中使用，用于不同项目获取token。 e9993fc787d94b6c886cbaa340f9c0f4 Authorization 使用AK/SK认证时必选。 签名认证信息。该值来源于请求签名结果。 - X-Sdk-Date 使用AK/SK认证时必选。 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 20150907T101459Z Host 使用AK/SK认证时必选。 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 code.test.com or code.test.com:443 Content-Length POST/PUT请求必填。 GET不能包含。 请求body长度，单位为Byte。 3495 X-Language 否 请求语言。支持配置如下值： zh-cn：中文 en-us：英文 en-us 华为云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参考AK/SK认证。 例如，对于IAM获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求方法 HTTP请求方法（也称为操作或动词），可告知服务正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 例如，在IAM获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器 域名 或IP，从地区和终端节点中获取。例如，图引擎服务在华北-北京一地区的endpoint为ges.cn-north-1.myhuaweicloud.com。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如IAM“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如，您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也是相同，所以简洁起见将这两部分省略。

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 执行该异步任务的jobId。 调用查询jobId接口查看任务执行状态、获取返回结果，详情参考Job管理API，调用结果参数说明，详见表3 data参数说明。 表3 data参数说明 参数 类型 说明 vertexNum Integer 图的点数。在多标签场景下，该值会按照label出现次数重复统计，如果需要统计真实实体个数，用cypher语句：match (n) return count(*)进行查询。 edgeNum Integer 图的边数。 labelDetails Object 不同label下的点边数目信息。若需要正常显示此字段，请按照表 labelDetails数据各要素说明建立点边索引。 表4 执行成功时，labelDetails数据各要素说明 参数 类型 说明 labelInVertex Object 不同label下面点的数目，若某label下点的数目为0则不显示。 若需要响应中包含该要素，请参考新建索引，新建索引时索引类型为"GlobalCompositeVertexIndex "，hasLabel为"true",属性列表置空。 labelInEdge Object 不同label下面边的数目，若某label下边的数目为0则不显示。 若需要响应中包含该要素，请参考新建索引，新建索引时索引类型为"GlobalCompositeEdgeIndex "，hasLabel为"true",属性列表置空。 errorMessage String 系统提示信息。 执行成功时，字段为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段为空。 执行失败时，用于显示错误码。

响应示例 状态码： 200 响应成功示例 Http Status Code: 200 { "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [demo] is not found", "errorCode": "GES.8001" }

Token认证 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 username、domainname 的获取请参考获取账号名和账号ID。password为用户密码。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 GES服务必须通过project的方式来获取token，不支持scope为domain的方式。 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 执行异步任务的JobID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_id 是 String 备份ID。 export_path 是 String OBS导出路径。

创建rf_admin_trust委托（可选） 进入华为云官网，打开控制台管理界面，鼠标移动至个人账号处，打开“ 统一身份认证 ”菜单。 图1 控制台管理界面 图2 统一身份认证菜单 进入“委托”菜单，搜索“rf_admin_trust”委托。 图3 委托列表 如果委托存在，则不用执行接下来的创建委托的步骤 如果委托不存在时执行接下来的步骤创建委托 单击步骤2界面中的“创建委托”按钮，在委托名称中输入“rf_admin_trust”，委托类型选择“云服务”，输入“ RFS ”，单击“下一步”。 图4 创建委托 在搜索框中输入“Tenant Administrator”权限，并勾选搜索结果，单击“下一步”。 图5 选择策略 选择“所有资源”，并单击“下一步“完成配置。 图6 设置授权范围 “委托”列表中出现“rf_admin_trust”委托则创建成功。 图7 委托列表 请用户在遵守适用的法律法规下合法使用云服务，按照游戏官方说明、指示和要求使用游戏，如用户涉及侵权，由用户自行承担责任。

一键快速部署 本章节主要帮助用户快速部署该解决方案。 表1 参数填写说明 参数名称 类型 是否可选 参数解释 默认值 vpc_name string 必填 虚拟私有云 VPC名称。该模板使用新建VPC，不允许重名。取值范围：1-57个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 deploy-a-palworld-dedicated-server security_group_name string 必填 安全组名称。该模板新建安全组，安全组规则请参考安全组规则修改（可选）进行配置。取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 deploy-a-palworld-dedicated-server ecs_name string 必填 弹性云服务器 E CS 名称。不允许重名。取值范围：1-60个字符组成，支持字母、数字、中文、下划线（_）、中划线（-）、英文句号（.）。 building-an-ha-elasticsearch-cluster-demo ecs_flavor string 必填 弹性云服务器 ECS规格。推荐使用4vCPUs16GB及以上规格，具体规格请参考官网弹性云服务器规格清单。 s6.xlarge.4（4U16G） system_disk_size number 必填 弹性云服务器 ECS系统盘大小，磁盘类型默认为高IO。单位：GB，取值范围为40～1,024，不支持缩盘。 100 ecs_password string 必填 弹性云服务器 ECS密码。取值范围：长度为8-26个字符，密码至少包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{()}]:,./?~#*）中的三种，Windows系统密码不能包含用户名或用户名的逆序，不能包含用户名中超过两个连续字符的部分。管理员账户默认root。 空 charging_mode string 必填 计费模式，默认自动扣费。可选值为：postPaid（按需计费）、prePaid（包年包月）。 postPaid charging_unit string 必填 订购周期类型。仅当charging_mode为prePaid（包年/包月）生效，此时该参数为必填参数。可选值为：month（月），year（年）。 month charging_period number 必填 订购周期。仅当charging_mode为prePaid（包年/包月）生效，此时该参数为必填参数。当charging_unit=month（周期类型为月）时，取值：1-9；当charging_unit=year（周期类型为年）时，取值：1-3。默认订购1个月。 1 登录华为云解决方案实践，选择“快速部署幻兽帕鲁专用服务器”解决方案。数据中心下拉菜单可以选择需要部署的区域，单击“一键部署（部署v0.1.51版本）”或者“一键部署（部署当前最新版本）”，跳转至解决方案创建堆栈界面。 图1 解决方案实施库 在选择模板界面中，单击“下一步”。 图2 选择模板 在配置参数界面中，参考表1完成自定义参数填写，单击“下一步”。 图3 配置参数 （可选，如果使用华为主账号或admin用户组下的IAM子账户可不选委托）在资源设置界面中，在权限委托下拉框中选择“rf_admin_trust”委托，单击“下一步”。 图4 资源栈设置 在配置确认页面中，单击“创建执行计划”。 图5 配置确认 在弹出的创建执行计划框中，自定义填写执行计划名称，单击“确定”。 图6 创建执行计划 待执行计划状态为“创建成功，待部署”后，单击“部署”，并且在弹出的执行计划确认框中单击“执行”。 图7 执行计划 图8 执行计划确认 （可选）如果计费模式选择“包年包月”，在余额不充足的情况下（所需总费用请参考表1）请及时登录费用中心，手动完成待支付订单的费用支付。 等待解决方案自动部署。部署成功后，单击“事件”，回显结果如下: 图9 资源创建成功 请用户在遵守适用的法律法规下合法使用云服务，按照游戏官方说明、指示和要求使用游戏，如用户涉及侵权，由用户自行承担责任。 父主题： 实施步骤

资源和成本规划 该解决方案主要部署如下资源，不同产品的花费仅供参考，实际以收费账单为准，具体请参考华为云官网价格： 表1 资源和成本规格(包年包月) 华为云服务 配置示例 每月预估花费 弹性云服务器 ECS 区域：华北-北京四 计费模式：包年包月 镜像：Ubuntu 22.04 规格：X86计算 | ECS | s6.xlarge.4 | 4vCPUs | 16GiB 系统盘：高IO | 100GB 购买量：1 466.20元 弹性公网IP EIP 按需计费：弹性公网IP保有费0.02/小时+公网流量费用0.8/GB 区域：华北-北京四 计费模式：按需计费 线路：动态BGP 公网带宽：按流量计费 带宽大小：300Mbit/s 购买量：1 0.80元/GB 合计 466.20元+ 弹性公网IP EIP费用 表2 资源和成本规格(按需计费) 华为云服务 配置示例 每月预估花费 弹性云服务器 ECS 按需计费：1.42元/小时 区域：华北-北京四 计费模式：按需计费 规格：X86计算 | ECS | s6.xlarge.4 | 4vCPUs | 16GiB 镜像：Ubuntu 22.04 系统盘：高IO | 100GB 购买量：1 购买时长：720小时 1,021.68元 弹性公网IP EIP 按需计费：弹性公网IP保有费0.02/小时+公网流量费用0.8/GB 区域：华北-北京四 计费模式：按需计费 线路：动态BGP 公网带宽：按流量计费 带宽大小：300Mbit/s 购买量：1 0.80元/GB 合计 1,021.68元+ 弹性公网IP EIP费用 请用户在遵守适用的法律法规下合法使用云服务，按照游戏官方说明、指示和要求使用游戏，如用户涉及侵权，由用户自行承担责任。

约束与限制 该解决方案部署前，需 注册华为账号 并开通华为云，完成实名认证，且账号不能处于欠费或冻结状态。如果计费模式选择“包年包月”，请确保账户余额充足以便一键部署资源的时候可以自动支付；或者在一键部署的过程进入费用中心，找到“待支付订单”并手动完成支付。 如果选用IAM委托权限部署资源，请确保使用的华为云账号有IAM的足够权限，具体请参考创建rf_admin_trust委托（可选）；如果使用华为主账号或admin用户组下的IAM子账户可不选委托，将采用当前登录用户的权限进行部署。 请用户在遵守适用的法律法规下合法使用云服务，按照游戏官方说明、指示和要求使用游戏，如用户涉及侵权，由用户自行承担责任。

云视频交付实施服务可以提供哪些服务？ 3D数字内容制作、虚拟视频制作、虚拟直播。 服务类型 服务内容 典型应用场景 3D数字内容制作 面向互娱、教育、企业、电商等场景，提供3D卡通数字人、美型数字人、写实数字人及相关配饰制作服务 面向制作行业、文旅、金融等行业客户，通过数字人视频介绍公司产品，传递公司价值 虚拟视频制作 提供视频镜头设计，结合数字人模型、虚拟背景、真实背景输出高质量视频 面向教育、培训等行业客户，使用数字人制作教育课件，降低教师重复繁琐的工作投入 虚拟直播 面向互娱、企业、电商等直播场景，提供数字人直播服务，用户可配置各种直播属性，即可生成主播视觉驱动的数字人直播流 面向娱乐、电商等行业客户，通过引入数字人和真人互动，提升直播带货效果，增加用户粘性 父主题： 关于服务咨询

责任矩阵 共同责任 双方商定并确认物联网上云与实施服务的具体的业务需求范围及目标； 双方商定并确认联网上云与实施服务的项目管理计划； 双方商定并确认联网上云与实施服务的方案内容并评审； 华为责任 华为须依照责任矩阵完成需求调研、方案设计和交付实施。 华为云得到客户授权后，授权数据仅限用于物联网上云与实施服务中涉及的服务内容，不得超出限定范围。 客户责任 客户指派一位项目负责人协助华为云联网上云与实施服务的需求调研和实施。此负责人应负责双方之协调及管理，负责审核、验收华为云提供的服务； 责任分工矩阵表 以下为职责描述案例，可酌情修改; R=责任方/Responsibility S=协助方/Support 序号 业务流程 工作内容 华为云 客户 1 需求调研 详细调研客户需求，双方协商服务范围 R R 2 方案设计 针对客户需求进行物联网上云与实施的方案设计，输出SOW R S 3 交付实施 根据SOW进行物联网上云与实施交付 R S 4 客户验收 对交付内容进行验收确认 R S