检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 OSM对外开放的API主要是为运营华为公有云服务的合作伙伴开放工单请求管理API,便于合作伙伴系统能够将华为云工单提交给华为云售后服务团队协助处理。 表1 工单管理接口列表 类型 说明 查询工单类目列表 用户在提交工单时可以选择问题关联的产品类型。 查询问题类型列表
API v2(推荐) 协议管理 附件管理 工单管理 工单权限管理 附件功能 授权管理 工单配额管理 提单基础配置查询 标签管理 工单留言管理 工单查询相关接口 关联工单管理 验证码管理 配置管理 一键诊断 智能客服 反馈
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 200 OSM.01010001 Param validation fail. 参数校验失败 参考API文档核对参数信息 200 OSM.01010002
如何调用API 构造请求 认证鉴权 返回结果
历史API 创建工单 查询工单列表 查询工单详情 上传附件 附件下载 删除附件 新增留言 服务评价 工单操作 查询工单问题所属产品 查询工单问题类型 查询模板 查询云服务区
工单操作 功能介绍 用户可以对提交的工单做一些操作,比如催单、删单、关单、撤单。 URI POST /v1.0/servicerequest/case/action 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 action 是 String 64
标签管理 创建标签 查询标签 删除标签 修改标签 查询工单关联标签接口 添加工单关联标签接口 删除工单关联标签接口 父主题: API v2(推荐)
创建工单 功能介绍 用户在使用产品的过程中,遇到问题或者需要帮助时可以提交工单。 URI POST /v1.0/servicerequest/case 请求消息 请求参数 请求参数如表1所示。 表1 参数说明 参数 是否必选 参数类型 取值范围 描述 subTypeId 否 String
协议管理 查看最新发布版本协议详情 查询用户是否签署最新协议 签署协议 父主题: API v2(推荐)
查询工单问题类型 功能介绍 创建工单的时候可以选择工单对应的问题类型。 URI GET /v1.0/servicerequest/case/businesstype 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 productCategoryId 否 String
查询模板 功能介绍 用户在提交工单的时候,需要按照模板填写,可以引导用户提交有效信息。 URI GET /v1.0/servicerequest/case/template 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 businessTypeId 是 String
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}
附件功能 上传附件 上传附件 删除附件 下载附件 图片展示 附件限制 父主题: API v2(推荐)
} 其中,error_code表示错误码,error_msg表示错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 解决方案 400 OSM.0001 Failed 参数校验异常 检查参数
删除附件 功能介绍 用户在创建工单或者新增留言前可以删除其上传错误的附件,重新上传。 URI DELETE /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryId 是 String
授权管理 验证授权主机 拒绝|撤销授权 查询登录类型 查询授权详情 租户确认授权 查看授权列表 查询堡垒机历史操作记录 查询堡垒机历史会话列表 查询堡垒机文件传输记录 父主题: API v2(推荐)
服务评价 功能介绍 用户在工单处理完成之后可以进行服务评价,提交一些评论。 URI POST /v1.0/servicerequest/case/evaluation 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId 是 String 32
上传附件 功能介绍 提交工单时,可以提交一些截图等文件。 URI POST /v1.0/servicerequest/case/accessory 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryName 是 String 512 附件名
新增留言 功能介绍 用户可以在工单详情页面新增留言,提交一些机密信息或者客服等处理中需要的信息或者进行催单询问进展等。 URI POST /v1.0/servicerequest/case/message 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 caseId
附件下载 功能介绍 用户在工单详情中可以下载查看其上传的附件。 URI GET /v1.0/servicerequest/case/accessory 请求消息 请求参数 参数 是否必选 参数类型 取值范围 描述 id 是 String - 附件下载支持批量下载。多个附件id用逗