检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除附件 功能介绍 用户在创建工单或者新增留言前可以删除其上传错误的附件,重新上传。 URI DELETE /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryId 是 String
查询模板 功能介绍 用户在提交工单的时候,需要按照模板填写,可以引导用户提交有效信息。 URI GET /v1.0/servicerequest/case/template 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 businessTypeId 是 String
"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
附件下载 功能介绍 用户在工单详情中可以下载查看其上传的附件。 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
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}
的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 工单管理的终端节点如下表所示,请您根据业务需要选择对应区域的终端节点。 表1 工单管理的终端节点 区域名称 区域 终端节点(Endpoint) 华南-广州 cn-south-1 osm.cn-south-1
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
创建工单 功能介绍 用户在使用产品的过程中,遇到问题或者需要帮助时可以提交工单。 URI POST /v1.0/servicerequest/case 请求消息 请求参数 请求参数如表1所示。 表1 参数说明 参数 是否必选 参数类型 取值范围 描述 subTypeId 否 String
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
示例一:创建工单 场景描述 本章节指导用户通过API创建工单。API的调用方法请参见如何调用API。 涉及接口 获取IAM用户Token(使用密码):用于鉴权认证。 上传附件:针对有附件的提单场景,通过该接口上传附件。 创建工单:提交工单。 查询工单详情:根据工单id查询工单的进展和详情。
查询工单问题类型 功能介绍 创建工单的时候可以选择工单对应的问题类型。 URI GET /v1.0/servicerequest/case/businesstype 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 productCategoryId 否 String
查询工单问题所属产品 功能介绍 用户在提交工单时可以选择问题关联的产品类型。 URI GET /v1.0/servicerequest/case/subtype 请求消息 请求参数 无 请求示例 无 响应消息 响应参数 表1 响应参数 参数 参数类型 描述 totalCount Integer
查询云服务区 功能介绍 用户在提交工单时可以选择关联的云服务区。 URI GET /v1.0/servicerequest/case/region 请求消息 请求参数 无 请求示例 无 响应消息 响应参数 表1 响应参数 参数 参数类型 描述 totalCount Integer
反馈评价 功能介绍 提交/取消反馈评价 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/irobot/feedbacks 表1 Query参数 参数
下载附件 功能介绍 下载附件 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/servicerequest/accessorys/{accessory_id}
查询公告 功能介绍 查询满足指定条件的公告列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/irobot/notices/search 请求参数
查询工具 功能介绍 查询满足指定条件的工具列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/irobot/tools/search 请求参数 表1