检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修订记录 发布日期 修订记录 2023-12-18 第五次正式发布。 API内容优化。 2021-05-28 第四次正式发布。 API内容优化。 2020-12-28 第三次正式发布。 API内容优化。 2019-09-23 第二次正式发布。 API内容优化。 2018-08-14
历史API 创建工单 查询工单列表 查询工单详情 上传附件 附件下载 删除附件 新增留言 服务评价 工单操作 查询工单问题所属产品 查询工单问题类型 查询模板 查询云服务区
使用前必读 概述 调用说明 终端节点 基本概念
状态码 表1 正常HTTP响应码 Status Code Description 200 OK 表2 异常HTTP响应码 Status Code Description 100 Continue 201 Created 202 Accepted 204 NO Content 400
删除附件 功能介绍 用户在创建工单或者新增留言前可以删除其上传错误的附件,重新上传。 URI DELETE /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryId 是 String
查询模板 功能介绍 用户在提交工单的时候,需要按照模板填写,可以引导用户提交有效信息。 URI GET /v1.0/servicerequest/case/template 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 businessTypeId 是 String
API v2(推荐) 协议管理 附件管理 工单管理 工单权限管理 附件功能 授权管理 工单配额管理 提单基础配置查询 标签管理 工单留言管理 工单查询相关接口 关联工单管理 验证码管理 配置管理 一键诊断 智能客服 反馈
"https://www.example.com/v3/projects" } } 从控制台获取项目ID 从控制台获取项目ID的步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。 图1 查看项目ID 父主题:
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 200 OSM.01010001 Param validation fail. 参数校验失败 参考API文档核对参数信息 200 OSM.01010002
如何调用API 构造请求 认证鉴权 返回结果
附件下载 功能介绍 用户在工单详情中可以下载查看其上传的附件。 URI GET /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 id 是 String - 附件下载支持批量下载。多个附件id用逗
服务评价 功能介绍 用户在工单处理完成之后可以进行服务评价,提交一些评论。 URI POST /v1.0/servicerequest/case/evaluation 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId 是 String 32
工单操作 功能介绍 用户可以对提交的工单做一些操作,比如催单、删单、关单、撤单。 URI POST /v1.0/servicerequest/case/action 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 action 是 String 64
上传附件 功能介绍 提交工单时,可以提交一些截图等文件。 URI POST /v1.0/servicerequest/case/accessory 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryName 是 String 512 附件名
新增留言 功能介绍 用户可以在工单详情页面新增留言,提交一些机密信息或者客服等处理中需要的信息或者进行催单询问进展等。 URI POST /v1.0/servicerequest/case/message 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId
的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 工单管理的终端节点如下表所示,请您根据业务需要选择对应区域的终端节点。 表1 工单管理的终端节点 区域名称 区域 终端节点(Endpoint) 华南-广州 cn-south-1 osm.cn-south-1
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
查询工单详情 功能介绍 查询已提交的某个华为云工单详情。 URI GET /v1.0/servicerequest/case/detail 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId 是 String 32 工单id。 具体ID请参见查询工单详情查询出的工单ID。
创建工单 功能介绍 用户在使用产品的过程中,遇到问题或者需要帮助时可以提交工单。 URI POST /v1.0/servicerequest/case 请求消息 请求参数 请求参数如表1所示。 表1 参数说明 参数 是否必选 参数类型 取值范围 描述 subTypeId 否 String
历史错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便尽快帮您解决问题。