华为云用户手册

响应参数 流式（Header中的stream参数为true） 状态码： 200 表4 流式输出的数据单元 参数 参数类型 描述 data String stream=true时，执行Agent的消息以流式形式返回。 生成的内容以增量的方式逐步发送回来，每个data字段均包含一部分生成的内容，直到所有data返回，响应结束。 表5 流式输出的数据单元 参数 参数类型 描述 event String 数据单元类型，有以下几种类型： start，开始节点，表示开始调用模型进行会话。 message，消息节点，表示模型返回的消息。 plugin_start，插件调用请求节点，表示调用插件的请求信息。 plugin_end，插件调用响应节点，表示调用插件的响应信息。 statistic_data，执行数据节点，包含本次调用的耗时信息。 summary_response，消息总结节点，包含本次调用的全量响应信息。 done，流式调用结束节点，表示流式响应结束。 content Object 消息块内容，不同event的消息块内容不同。 createdTime long 消息块返回的时间戳，如1733817348963。 latency Object 耗时，包括以下三个元素： plugin，插件调用耗时 model，模型调用耗时 overall，总耗时 plugin Object 插件请求信息，包括以下两个元素： name，插件名 arguments，插件入参名

请求示例 流式（Header中的stream参数为true） POST https://{endpoint}/v1/{project_id}/agent-run/agents/{agent_id}/conversations/{conversation_id} Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... stream: true Request Body: { "query": "查询A12会议室在9:00到10:00的状态" }

响应示例 data:{"event":"start","createdTime":1735558575017} data:{"event":"message","content":"好的","createdTime":1735558576300} data:{"event":"message","content":"，","createdTime":1735558576301} data:{"event":"message","content":"我将","createdTime":1735558576301} data:{"event":"message","content":"调用","createdTime":1735558576302} data:{"event":"message","content":"query","createdTime":1735558576302} data:{"event":"message","content":"_","createdTime":1735558576302} data:{"event":"message","content":"meeting","createdTime":1735558576302} data:{"event":"message","content":"_","createdTime":1735558576302} data:{"event":"message","content":"room","createdTime":1735558576303} data:{"event":"message","content":"_status","createdTime":1735558576303} data:{"event":"message","content":"工具","createdTime":1735558576303} data:{"event":"message","content":"来","createdTime":1735558576304} data:{"event":"message","content":"查询","createdTime":1735558576304} data:{"event":"message","content":"A","createdTime":1735558576304} data:{"event":"message","content":"12","createdTime":1735558576304} data:{"event":"message","content":"会议室","createdTime":1735558576305} data:{"event":"message","content":"在","createdTime":1735558576305} data:{"event":"message","content":"9","createdTime":1735558576305} data:{"event":"message","content":":00","createdTime":1735558576305} data:{"event":"message","content":"到","createdTime":1735558576306} data:{"event":"message","content":"10","createdTime":1735558576306} data:{"event":"message","content":":00","createdTime":1735558576306} data:{"event":"message","content":"的状态","createdTime":1735558576306} data:{"event":"message","content":"。","createdTime":1735558576306} data:{"event":"message","content":"请","createdTime":1735558576307} data:{"event":"message","content":"稍","createdTime":1735558576307} data:{"event":"message","content":"等","createdTime":1735558576307} data:{"event":"message","content":"。","createdTime":1735558576307} data:{"event":"message","content":" ","createdTime":1735558576307} data:{"event":"message","content":" query","createdTime":1735558576307} data:{"event":"message","content":"_","createdTime":1735558576308} data:{"event":"message","content":"meeting","createdTime":1735558576308} data:{"event":"message","content":"_","createdTime":1735558576308} data:{"event":"message","content":"room","createdTime":1735558576308} data:{"event":"message","content":"_status","createdTime":1735558576308} data:{"event":"message","content":"|","createdTime":1735558576308} data:{"event":"message","content":"{\"","createdTime":1735558576309} data:{"event":"message","content":"meeting","createdTime":1735558576309} data:{"event":"message","content":"Room","createdTime":1735558576309} data:{"event":"message","content":"\":","createdTime":1735558576309} data:{"event":"message","content":"{\"","createdTime":1735558576309} data:{"event":"message","content":"number","createdTime":1735558576310} data:{"event":"message","content":"\":","createdTime":1735558576310} data:{"event":"message","content":" 12","createdTime":1735558576310} data:{"event":"message","content":"}","createdTime":1735558576310} data:{"event":"message","content":",\"","createdTime":1735558576310} data:{"event":"message","content":"start","createdTime":1735558576310} data:{"event":"message","content":"\":\"","createdTime":1735558576311} data:{"event":"message","content":"9","createdTime":1735558576311} data:{"event":"message","content":":00","createdTime":1735558576311} data:{"event":"message","content":"\",\"","createdTime":1735558576311} data:{"event":"message","content":"end","createdTime":1735558576311} data:{"event":"message","content":"\":\"","createdTime":1735558576311} data:{"event":"message","content":"10","createdTime":1735558576311} data:{"event":"message","content":":00","createdTime":1735558576312} data:{"event":"message","content":"\"}","createdTime":1735558576312} data:{"event":"message","content":" ","createdTime":1735558576312} data:{"event":"plugin_start","type":"plugin","latency":{"overall":1.3},"plugin":{"name":"query_meeting_room_status","arguments":"{\"meetingRoom\": {\"number\": 12}, \"start\": \"9:00\", \"end\": \"10:00\"}"},"createdTime":1735558576316} data:{"event":"plugin_end","content":{"result":"空闲"},"role":"function","latency":{"overall":1.51,"plugin":0.0},"createdTime":1735558576521} data:{"event":"start","createdTime":1735558576522} data:{"event":"message","content":"A","createdTime":1735558576976} data:{"event":"message","content":"12","createdTime":1735558576977} data:{"event":"message","content":"会议室","createdTime":1735558576977} data:{"event":"message","content":"在","createdTime":1735558576977} data:{"event":"message","content":"9","createdTime":1735558576978} data:{"event":"message","content":":00","createdTime":1735558576978} data:{"event":"message","content":"到","createdTime":1735558576978} data:{"event":"message","content":"10","createdTime":1735558576978} data:{"event":"message","content":":00","createdTime":1735558576978} data:{"event":"message","content":"的时间","createdTime":1735558576978} data:{"event":"message","content":"段","createdTime":1735558576979} data:{"event":"message","content":"内","createdTime":1735558576979} data:{"event":"message","content":"是","createdTime":1735558576979} data:{"event":"message","content":"空闲","createdTime":1735558576979} data:{"event":"message","content":"的","createdTime":1735558576979} data:{"event":"message","content":"。","createdTime":1735558576980} data:{"event":"statistic_data","latency":{"overall":1.97},"createdTime":1735558576986} data:{"event":"summary_response","content":"A12会议室在9:00到10:00的时间段内是空闲的。","role":"assistant","createdTime":1735558576987} data:{"event":"done","createdTime":1735558577011}

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。遇到“APIG”开头的错误码，请参考本文档进行处理。 表1 错误码 模块 错误码 错误信息 说明 建议解决方法 模型推理 PANGU.0001 unknown error. 未知错误。 请联系服务技术支持协助解决。 PANGU.0010 parameter illegal. 请求参数错误。 请参考《API文档》输入正确的请求参数，并重新调试API。 PANGU.0011 auth failed. 认证失败。 认证鉴权失败，请参考《API文档》认证鉴权章节重新进行认证。 PANGU.0012 auth info missing. 缺少身份验证信息。 请检查调用API时是否有传入认证鉴权信息。 PANGU.0031 Inner service exception. 服务内部异常。 请联系服务技术支持协助解决。 PANGU.3305 call cal tokens failed 获取token错误。 请检查调用API时使用的token是否完整，是否存在错误。 PANGU.3254 The requested resource does not exist. 资源不存在。 请检查调用API时projectId和deploymentId是否填写正确。 PANGU.3259 NLP service status is not running or have been deleted. 推理服务状态异常。 请检查调用API时deploymentId是否正确，并检查模型的部署状态是否存在异常，如果仍无法解决请联系服务技术支持协助解决。 PANGU.3267 qps exceed the limit. QPS超出限制。 请降低请求频率。 PANGU.3278 required api parameter is not present. 请求参数丢失。 请检查调用API时请求参数是否填写完整、是否有拼写错误、取值是否正确。 PANGU.3307 domain has not added the opened API. 账号未开通该 API服务 。 请确认是否已开通该API服务。 PANGU.3308 The accessed API does not match the existing API. 访问的API与已开通的API服务不匹配。 请确认调用的API是否填写错误。 PANGU.3315 The accessed API's model instance is not public. API模型实例未公开。 请检查是否具备盘古大模型服务的使用权限，或联系服务运维人员协助解决。 PANGU.3316 create agency fail. 创建代理失败。 请联系服务运维人员协助解决。 PANGU.3317 max tokens Number Illegal. 最大token不合法 请参考《API文档》检查请求参数中输入的token数值是否不在范围内，并重新调试API。 PANGU.3318 tolal ContentLength Illegal. Content长度不合法 请参考《API文档》检查请求参数中输入的Content参数长度是否不在范围内，并重新调试API。 PANGU.3319 Private service permission error. 权限错误。 请联系服务技术支持协助解决。 PANGU.3320 The parameter [n] can only be 1 or 2 when calling non-streaming. 非流式调用推理服务传的参数只能是1或者2。 请使用正确的取值：1或者2。 PANGU.3321 The parameter [n] can only be 1 when calling streaming. 流式调用推理服务n只能取1。 请使用正确的取值：1。 IIT.0201 The input param is invalid!/The input param is invalid, please check your key! 请求参数不合法。 请检查请求参数是否填写正确。 IIT.0202 Interval Server Error! 内部错误。 请联系服务技术支持协助解决。 IIT.0203 The input param is invalid, the input data lens is less than the train data lens! 请求参数不合法，输入参数中的数据长度小于训练所用数据长度。 请确认请求body中特征名称、特征数量是否与训练数据中的特征一致。 APIG.0101 The API does not exist or has not been published in the environment. 访问的API不存在或尚未在环境中发布。 请检查API的URL是否拼写正确，例如，URL中是否缺少project_id。 HTTP请求方法（POST，GET等）是否正确。 APIG.0201 Backend timeout. 请求超时。 请检查原调用请求是否过于频繁，如果是并发过大，可以通过重试机制解决，在代码里检查返回值，碰到这个并发错误可以延时一小段时间（如2-5s）重试请求；也可以后端检查上一个请求结果，上一个请求返回之后再发送下一个请求，避免请求过于频繁。 请与技术支持确认，API是否已完成部署。 APIG.0301 Incorrect IAM authentication information. IAM身份验证信息不正确： decrypt token fail：token解析失败。 token expires：token过期。 verify aksk signature fail：AK/SK认证失败。 x-auth-token not found：未找到x-auth-token参数。 token解析失败，请检查获取token的方法，请求体信息是否填写正确，token是否正确；检查获取token的环境与调用的环境是否一致。 token超时（token expires） ，请重新获取token，使用不过期的token。 请检查AK/SK是否正确（AK对应的SK错误，不匹配；AK/SK中多填了空格）。 AK/SK频繁出现鉴权出错，连续错误5次以上，被锁定5分钟（5分钟内，则一直认为其是异常的鉴权请求），5分钟后解锁重新认证。 检查账号权限，是否欠费，被冻结等。 检查调用API时，请求header参数X-Auth-Token是否拼写正确。 APIG.0308 The throttling threshold has been reached: policy user over ratelimit,limit:XX,time:1 minute. 发送请求超过了服务的默认配置限流。 通过重试机制，在代码里检查返回值，碰到并发错误可以延时一小段时间（如2-5s）重试请求。 后端检查上一个请求结果，上一个请求返回之后再发送下一个请求，避免请求过于频繁。 数据工程 MAStudio.02010005 content type [%s] not support, only [%s] support 文件内容[{0}]不支持, 只支持[{1}] 请参考报错信息中的文件内容类型，报错信息会返回支持的文件内容，请使用正确的文件内容。 MAStudio.02010027 dataset [%s] status is not online 数据集[{0}]状态不是online 请使用状态是在线状态的数据集。 MAStudio.02010028 dont have role [%s] 没有[{0}]角色 无操作权限，请根据错误提示申请对应空间内的角色操作权限。 MAStudio.02060009 Verification failed. Please check the content format is consistent with the template requirements. 校验失败，请检查文件内容格式与样例要求一致 文件内容与样例文件要求不一致，修改校验失败的文件使之与样例文件格式相同。 MAStudio.02060013 Currently, the content_type [{0}] of dataset is not supported, please purchase the relevant feature pack. 当前不支持数据集类型[{0}]，请先购买相关特性包 不支持当前导入选择的数据集类型，需要订购相关的数据工程特性包。 MAStudio.02060019 import user defined file [{0}] to [{1}] failed. 导入用户自定义文件[{0}]到[{1}]失败 导入任务调用用户自定义导入数据转换格式脚本时发生错误，请检查错误信息中导入文件以及脚本文件是否正确。 MAStudio.02060021 The request for the data-management service failed, and returned [{0}]. 请求数据管理服务失败，返回[{0}] 调用数据管理接口更新数据集时发生异常，请检查数据管理微服务是否运行正常。 MAStudio.02060022 A running task cannot be started again. 运行中的任务不能再次启动 请等待数据导入任务运行结束或手动停止任务后再启动。 MAStudio.02060023 A stopping task cannot be stopped again. 停止中的任务不能再次停止 数据导入任务停止中，任务无法没重复停止。 MAStudio.02060025 The file [{0}] size exceeds the maximum limit of [{1}]. 文件[{0}]大小超过最大限制[{1}] 导入任务限制导入的TAR压缩文件大小不得超过500MB，请确认文件大小是否满足要求。 MAStudio.02060026 There is no jsonl file in the directory. 目录下没有jsonl文件 导入图片+Caption及图片+QA对类型数据集时，要求源数据中包含jsonl文件，在对当前导入数据进行校验时未匹配到jsonl文件，请确认导入数据中包含jsonl文件。 MAStudio.02071031 Job [%s] is [%s] and can not be deleted. 任务[{0}]处于处理中状态，无法删除。 运行中的数据发布任务无法被删除，等待任务运行结束后删除。 MAStudio.02010002 X-Auth-Token is invalid X-Auth-Token不合法 该token没有权限访问，使用确保该用户在IAM中配置正确权限。 MAStudio.02060018 X-Auth-Token is invalid: [{0}]. X-Auth-Token无效: [{0}] 解析或获取token失败，请检查调用接口时传入的X-Auth-Token是否有效以及X-Auth-Token与ProjectId是否匹配。 MAStudio.02012001 forbidden to do this action 无权进行该操作 该操作用户无操作权限，请获取对应IAM权限后再重试。 MAStudio.02010003 dataset [%s] not found in catalog [%s] workspace [%s] 数据集[{0}]无法在目录[{1}]下空间[{2}]中找到 该数据集在报错信息中提示的空间和catalog中不存在，请填写正确的参数。 MAStudio.02010043 user [{0}] [{1}] not found in workspace [{2}] 数据集[{0}]在空间[{1}]中没有文件，请检查 请进入该空间下检查对应的数据集在该空间下是否存在。 MAStudio.02011003 user [{0}] [{1}] not found in workspace [{2}] 在空间[{2}]中未查询到用户[{0}] [{1}] 请确认对应操作数据集的用户在该空间下具备操作权限。 MAStudio.02060032 Call mrs api failed: [{0}]. 调用 MRS API失败: [{0}] 调用MRS服务失败，请优先检查MRS集群是否运行正常，如无法解决，请联系MRS服务技术支持。 MAStudio.02060033 Mrs job is failed, job id: [{0}]. MRS作业失败, 作业id: [{0}] MRS作业失败，请根据错误信息中的作业id查看MRS manager运维界面上yarn组件中找到对应的application运行日志定位问题。 MAStudio.02071001 Read file [%s] failed 读取文件[{0}]失败 数据发布任务无法读取数据集文件，请检查当前操作用户是否具备OBS桶相关的文件读权限，确保权限配置正确。 MAStudio.02071002 Dataset [%s] is not found 找不到数据集[{0}] 数据集查找失败，请检查数据发布任务中填写的数据集信息是否填写正确。 MAStudio.02071003 Dataset [%s] status is invalid 数据集[{0}]状态不合法 该状态数据集无法被发布，确保发布任务中填写的数据集状态为上线状态。 MAStudio.02071005 Write file [%s] failed 写入文件[{0}]失败 数据发布任务无法写入数据集文件，请检查当前操作用户是否具备OBS桶相关的文件写权限，确保权限配置正确。 MAStudio.02071011 Data format is invalid, please check dataset [%s] line [%s]. 数据格式不合法，请检查数据集[{0}]第[{1}]行。 数据集的文件内容不合法，请根据错误描述中查找对应数据集文件内容格式是否正确。 MAStudio.02071017 source datasets size is up to limit [%s]GB 待发布数据大小超过上限[{0}]GB 发布任务选择的数据集超过错误信息中提示的数据大小上限，请删除数据集中的部分文件以满足发布要求。 MAStudio.02072003 Mrs job is failed, job id: [%s] Mrs作业失败，作业id：[{0}] MRS作业失败，请根据错误信息中的作业id查看MRS manager运维界面上yarn组件中找到对应的application运行日志定位问题。 父主题： 附录

请求示例 POST https://{endpoint}/v1/{project_id}/agent-run/workflows/{workflow_id}/conversations/{conversation_id} Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... stream: true Request Body: { "inputs": { "query": "你好" }, "plugin_configs": [ { "plugin_id": "xxxxxxxxx", "config": { "key": "value" } } ] }

响应示例 非流式（Header中的stream参数为false） 输入节点返回： { "conversation_id": "2c90493f-803d-431d-a197-57543d414317", "messages": [ { "role": "assistant", "content": "{\"inputs\": [{\"actualType\": \"string\", \"sourceType\": \"null\", \"description\": \"姓名\", \"name\": \"name\", \"type\": \"string\", \"required\": true}]}", "nodeId": "node_1745928389632", "nodeType": "Input", "nodeName": "输入" } ], "status": { "code": 3, "desc": "waiting" }, "start_time": 1734336269313, "end_time": 1734336270908 } 提问器节点返回： { "conversation_id": "f9a5540f-0c92-4f28-bd6e-f96ce04f5cc81", "messages": [ { "role": "assistant", "content": "请您提供姓名, 年龄相关的信息", "nodeId": "node_1745929628452", "nodeType": "Questioner", "nodeName": "提问器" } ], "status": { "code": 3, "desc": "waiting" }, "start_time": 1745929778250, "end_time": 1745929779951 } 结束节点返回： { "conversation_id": "2c90493f-803d-431d-a197-57543d414317", "outputs": { "responseContent": "你好！有什么我可以帮助你的吗？" }, "messages": [], "status": { "code": 1, "desc": "succeeded" }, "start_time": 1734337068533, "end_time": 1734337082545 } 流式（Header中的stream参数为true或不传） 输入节点返回： data:{"event":"workflow_started","data":{"start_time":1745929087614}} data:{"event":"message","data":{"text":"{\"inputs\": [{\"actualType\": \"string\", \"sourceType\": \"null\", \"description\": \"姓名\", \"name\": \"name\", \"type\": \"string\", \"required\": true}]}","index":0,"node_id":"node_1745928389632","node_type":"Input","node_name":"输入"}} data:{"event":"message","data":{"text":"","node_id":"node_1745928389632","node_type":"Input","node_name":"输入","is_finished":true}} data:{"event":"end"} 提问器节点返回： data:{"event":"workflow_started","data":{"start_time":1745929709955}} data:{"event":"message","data":{"text":"请您提供姓名, 年龄相关的信息","index":0,"node_id":"node_1745929628452","node_type":"Questioner","node_name":"提问器"}} data:{"event":"message","data":{"text":"","node_id":"node_1745929628452","node_type":"Questioner","node_name":"提问器","is_finished":true}} data:{"event":"end"} 结束节点返回： data:{"event":"workflow_started","data":{"start_time":1745929897770}} data:{"event":"message","data":{"text":"","index":0,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"你好","index":1,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"！","index":2,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"有什么我可以帮助你的吗？","index":3,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"","node_id":"node_end","node_type":"End","node_name":"结束","is_finished":true}} data:{"event":"workflow_finished","data":{"status":{"code":1,"desc":"succeeded"},"outputs":{"responseContent":"你好！有什么我可以帮助你的吗？"},"start_time":1745929897770,"end_time":1745929898600}} data:{"event":"end"}

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 以下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token请参考认证鉴权中的“Token认证”。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见：AK/SK。 添加消息头后的请求如下所示： POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD...

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 将消息体加入后的请求如下所示，详细参数解释可参考文档API章节。 POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD... { "messages": [ { "content": "介绍下长江，以及长江中典型的鱼类" } ], "temperature": 0.9, "max_tokens": 600 } 综上，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于接口，您可以从响应消息部分看到返回参数及参数说明。

请求URI 请求URI由如下部分组成： {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URI 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器 域名 或IP。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”。 获取请求URI的步骤详见请求URI，示例如下： https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions

请求方法 HTTP请求方法，表示服务正在请求操作类型，包括： GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在接口的URI部分，请求方法为“POST”，例如： POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions

请求示例 GET https://{endpotint}/v1/{project_id}/workspaces/{workspace_id}/data-management/lineages?limit=100&from_path=bucket/folder1/folder2 Requet Header: Content_Type: application/json X-Auth-Token: MIIVV... Request Params: limit: 1000 from_path: bucket/folder1/folder2

响应示例 { "lineages": [ { "id": null, "from_id": null, "from_name": null, "from_catalog": null, "from_type": "OBS", "to_id": "1352299121133883392", "to_name": null, "to_catalog": "ORIGINAL", "to_type": "DATASET", "process_id": null, "process_name": null, "process_type": null, "train_job_name": null, "model_type": null, "train_type": null, "create_time": null, "from_path": "bucket/folder", "from_path_existed": null }, { "id": "1352299380551585793", "from_id": "1352299121133883392", "from_name": "时序-回归-test", "from_catalog": "ORIGINAL", "from_type": "DATASET", "to_id": "1352299379473649664", "to_name": "pub_时序回归", "to_catalog": "PUBLISH", "to_type": "DATASET", "process_id": "lt_97a2aa4cca744775aa5c7cfe3cb36121", "process_name": "pub_时序回归", "process_type": "PUBLISH", "train_job_name": null, "model_type": null, "train_type": null, "create_time": null, "from_path": null, "from_path_existed": null } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表2 请求Query参数 参数 是否必选 参数类型 描述 limit 是 integer 参数解释： 接口返回的血缘数量上限 约束限制： 无 取值范围： [1, 1000] 默认取值： 100 from_path 是 string 参数解释： 来源obs路径 约束限制： 最终租户桶下的OBS全路径 取值范围： 无 默认取值： 无

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result Object 预测结果信息。 pred_proba Array 预测结果对应的置信度，每条结果为一个Dict，Dict的键值对分别表示预测结果、置信度。 说明：请求字段predict_proba配置为true时，响应body才返回pred_proba子项，否则无该子项。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx } ]， "predict_proba": true }

响应示例 { "result": [ "0", "1", ... "0" ], "pred_proba": [ { “0”: 0.791, “1”: 0.209 }, { “0”: 0.103, “1”: 0.897 }, ... { “0”: 0.665, “1”: 0.335 }, ] }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 待进行预测的数据，data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 约束限制： 待预测特征名需要与训练数据中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2……进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 predict_proba 否 boolean 参数解释： 是否输出置信度 约束限制： 无 取值范围： true或false 默认取值： 非必填项，默认false。

响应示例 { "data": [ { "prediction":{ "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] } } ], "time_cost": { "infer_cost_time": "82.609 ms", "postprocess_cost_time": "0.29 ms", "preprocess_cost_time": "0.1332 ms", "service_cost_total_time": "84.965 ms" } }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 时序数据请求的批处理队列。 约束限制： 盘古时序预测回归任务的输入数据内容，用字典承载。输入数据字典中，键对应特征列名，值为序列数据具体内容。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 context_len 否 int 参数解释： 时序任务的数据窗口大小，该参数主要服务于支持多尺度窗口的模型的推理。 约束限制： 填写时需要保证输入序列长度大于等于该值。 取值范围： min:32 max:512 -1为当前服务模型的默认大小。 默认取值： 128 prediction_len 否 int 参数解释： 时序预测输出的窗口长度。数值越大输出预测的时间范围越大，但相应的显存占用会增加以及模型预测精度可能会下降。 约束限制： 注若基于已发布模型的进行增量微调，输出窗口需要与其保持一致。 取值范围： 建议取值范围48至96，且尽量选择预测目标周期的整数倍 默认取值： 96

请求示例 { "context_len": 256, "prediction_len": 96, "data": [ { "context": { "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...], "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] } }, { "context": { "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...], "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] } } ] }

状态码 HTTP状态码为三位数，分成五个类别：1xx：相关信息；2xx：操作成功；3xx：重定向；4xx：客户端错误；5xx：服务器错误。 状态码如下所示。 状态码 编码 状态说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTPS的新版本协议。 200 OK 服务器已成功处理了请求。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其他地址，使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Fou 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Timeout 服务器等待请求发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request URI Too Long 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested Range Not Satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 Unprocessable Entity 请求格式正确，但是由于含有语义错误，无法响应。 429 Too Many Requests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 Gateway Timeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version Not Supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。 父主题： 附录

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 待进行预测的数据，data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据 约束限制： data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 待预测特征名需要与训练数据中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2……进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx } ] }

URI POST /v1/{project_id}/infer-api/proxy/service/{deployment_id}/perm-feat-importance 获取URI方式请参见请求URI。 表1 推理接口路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID。 deployment_id 是 String 模型的部署ID，获取方法请参见获取模型部署ID。

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx, "target": 0, }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx, "target": 1 } ], "fi_args":{ "num_shuffle_sets": 1, "sample_num": 1000 } } 此处data列表的长度至少为1000，建议通过以下代码根据csv文件生成请求体（DATA_NUM为从csv文件中采样数据的数量）： import random import json import pandas as pd ENCODING_TYPE = "utf-8" DATA_NUM = 1200 data_path = "path/to/xxx.csv" df = pd.read_csv(data_path, encoding=ENCODING_TYPE) data_list = df.to_dict("records") data_list = random.sample(data_list, DATA_NUM) request_data = { "data": data_list, "fi_args": { "num_shuffle_sets": 1, "sample_num": 1000, } } request_str = json.dumps(request_data) print(request_str)

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 待进行预测的数据，从输入的特征数据中检测是否存在异常值。 约束限制： data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 待预测特征名需要与训练数据中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2……进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 predict_proba 否 boolean 参数解释： 是否输出置信度 约束限制： 无 取值范围： true或false 默认取值： 非必填项，默认false。

响应示例 { "result": [ "0", "1", ... "0" ], "pred_proba": [ { “0”: 0.791, “1”: 0.209 }, { “0”: 0.103, “1”: 0.897 }, ... { “0”: 0.665, “1”: 0.335 }, ] }

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx } ]， "predict_proba": true }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result Object 预测结果信息。 pred_proba Array 预测结果对应的置信度，每条结果为一个Dict，Dict的键值对分别表示预测结果、置信度。 说明：请求字段predict_proba配置为true时，响应body才返回pred_proba子项，否则无该子项 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx, "target": 0, }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx, "target": 1 } ], "fi_args":{ "num_shuffle_sets": 1, "sample_num": 1000 } } 此处data列表的长度至少为1000，建议通过以下代码根据csv文件生成请求体（DATA_NUM为从csv文件中采样数据的数量）： import random import json import pandas as pd ENCODING_TYPE = "utf-8" DATA_NUM = 1200 data_path = "path/to/xxx.csv" df = pd.read_csv(data_path, encoding=ENCODING_TYPE) data_list = df.to_dict("records") data_list = random.sample(data_list, DATA_NUM) request_data = { "data": data_list, "fi_args": { "num_shuffle_sets": 1, "sample_num": 1000, } } request_str = json.dumps(request_data) print(request_str)