华为云用户手册

响应示例 状态码： 200 response of 200 { "partners_service_info" : [ { "customer_id" : "test", "customer_name" : "test", "service_time_zone" : "GMT+8", "service_time_day" : "5", "service_time_hour" : "8" } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 表2 请求Body参数 参数 是否必选 参数类型 描述 project_id 否 String 项目ID 最小长度：0 最大长度：128 region 否 String 区域 最小长度：1 最大长度：128

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总数 最小值：0 最大值：65535 result Array of DiagnoseResourceVo objects 诊断记录列表 数组长度：0 - 65535 表4 DiagnoseResourceVo 参数 参数类型 描述 fault String ID 最小长度：0 最大长度：64 id String 状态 最小长度：0 最大长度：64 name String 名称 最小长度：0 最大长度：64 accessIPv4 String ip4地址 最小长度：0 最大长度：64 accessIPv6 String ip6地址 最小长度：0 最大长度：64 status String 状态 最小长度：0 最大长度：64 progress String 进度 最小长度：0 最大长度：64 tenantId String 前端id 最小长度：0 最大长度：64 userId String 用户id 最小长度：0 最大长度：64 metadata Object 资源元数据 最小长度：0 最大长度：64 hostId String 主机id 最小长度：0 最大长度：64

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32 表2 请求Body参数 参数 是否必选 参数类型 描述 operation 是 String 执行的操作 最小长度：0 最大长度：64 privilege 否 String 权限标识 最小长度：0 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 notices Array of Notice objects 推荐公告列表 数组长度：0 - 2147483647 error_code String 错误码 最小长度：0 最大长度：32 error_msg String 错误描述 最小长度：0 最大长度：32 表4 Notice 参数 参数类型 描述 id String 公告Id 最小长度：0 最大长度：64 content String 公告内容 最小长度：0 最大长度：65535 create_time Long 创建时间 最小值：0 最大值：9223372036854775807 update_time Long 更新时间 最小值：0 最大值：9223372036854775807

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 x-service-key 否 String 调用智能客服服务标志。 最小长度：1 最大长度：32 x-site 否 String 站点标记，0-中国站 1-国际站 最小长度：0 最大长度：1 x-language 否 String 区域语言简写，en-us zh-cn 最小长度：0 最大长度：32 表2 请求Body参数 参数 是否必选 参数类型 描述 top 否 Integer 返回匹配度最高的数据条数 最小值：1 最大值：100 product_type_id 是 String 产品类型Id 最小长度：0 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 sub_customer_infos Array of SubCutomerInfoV2 objects 子用户列表 数组长度：0 - 65535 表4 SubCutomerInfoV2 参数 参数类型 描述 mobile String 手机号（匿名化） 最小长度：0 最大长度：32 email String 邮箱（匿名化） 最小长度：0 最大长度：256 customer_id String 客户id 最小长度：0 最大长度：64 domain_id String 主账号id 最小长度：0 最大长度：64 customer_name String 客户名称（匿名化） 最小长度：0 最大长度：256 area_code String 国家码 最小长度：0 最大长度：16

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32

响应示例 状态码： 200 response of 200 { "sub_customer_infos" : [ { "mobile" : "123", "email" : "123", "customer_id" : "123", "domain_id" : "123", "customer_name" : "123", "area_code" : "86" } ] }

响应示例 状态码： 200 成功返回200 { "count" : 1, "message_list" : [ { "type" : 0, "replier" : "test", "content" : "test", "create_time" : "2020-07-09 00:00:00", "replier_name" : "test", "is_first_message" : 1, "iam_user_type" : 0, "accessory_list" : [ { "accessory_id" : "123", "file_actual_name" : "test" } ] } ] }

URI GET /v2/servicerequest/cases/{case_id}/messages 表1 路径参数 参数 是否必选 参数类型 描述 case_id 是 String 工单id 最小长度：0 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 group_id 否 String 组id 最小长度：0 最大长度：64 offset 否 Integer 查询偏移量 最小值：0 最大值：65535 limit 否 Integer 查询数量 最小值：0 最大值：100

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 最小值：0 最大值：65535 message_list Array of QueryMessageInfoV2 objects 留言列表 数组长度：0 - 65535 表5 QueryMessageInfoV2 参数 参数类型 描述 type Integer 类型，可以删除 最小值：0 最大值：1 replier_type Integer 回复人类型 最小值：0 最大值：3 replier String 回复人id 最小长度：0 最大长度：64 content String 留言内容 最小长度：0 最大长度：400 create_time String 创建时间 replier_name String 回复人名称 最小长度：0 最大长度：256 is_first_message Integer 是否是第一条留言 最小值：0 最大值：1 iam_user_type Integer 子用户类型 最小值：0 最大值：3 accessory_list Array of SimpleAccessoryV2 objects 附件列表 数组长度：0 - 5 表6 SimpleAccessoryV2 参数 参数类型 描述 accessory_id String 附件id 最小长度：0 最大长度：64 file_actual_name String 附件实际名称 最小长度：0 最大长度：256

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 您也可以通过这个视频教程了解AK/SK认证的使用：https://bbs.huaweicloud.com/videos/69d4cf0269c34d41ab3dff02c73dd6c9。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 标签名称 最小长度：1 最大长度：64 color 是 String 颜色值，如#000000 最小长度：1 最大长度：7

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 x-service-key 否 String 调用智能客服服务标志。 最小长度：1 最大长度：32 x-site 否 String 站点标记，0-中国站 1-国际站 最小长度：0 最大长度：1 x-language 否 String 区域语言简写，en-us zh-cn 最小长度：0 最大长度：32

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：32 error_msg String 错误描述 最小长度：0 最大长度：32 feedback_options Array of FeedbackOption objects 选项列表 数组长度：0 - 100000 表4 FeedbackOption 参数 参数类型 描述 feedback_option_id String 反馈选项id 最小长度：0 最大长度：65535 feedback_option_name String 反馈选项名称 最小长度：0 最大长度：65535

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 x-service-key 否 String 调用智能客服服务标志。 最小长度：1 最大长度：32 x-site 否 String 站点标记，0-中国站 1-国际站 最小长度：0 最大长度：1 x-language 否 String 区域语言简写，en-us zh-cn 最小长度：0 最大长度：32 表3 请求Body参数 参数 是否必选 参数类型 描述 top 否 Integer 返回匹配度最高的数据条数 最小值：1 最大值：100 product_type_id 是 String 产品类型Id 最小长度：0 最大长度：64 business_type_id 否 String 业务类型Id 最小长度：0 最大长度：64 problem_type_id 否 String 问题类型Id 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 articles Array of Article objects 热点/推荐案例列表 数组长度：0 - 2147483647 error_code String 错误码 最小长度：0 最大长度：32 error_msg String 错误描述 最小长度：0 最大长度：32 表5 Article 参数 参数类型 描述 id String 案例Id 最小长度：0 最大长度：64 code String 案例编码 最小长度：0 最大长度：64 name String 案例名称 最小长度：0 最大长度：1024 url String 案例链接 最小长度：0 最大长度：2048 create_time Long 创建时间 最小值：0 最大值：9223372036854775807 update_time Long 更新时间 最小值：0 最大值：9223372036854775807 product_type_id String 产品类型Id 最小长度：0 最大长度：64 business_type_id String 业务类型Id 最小长度：0 最大长度：64 problem_type_id String 问题类型Id 最小长度：0 最大长度：64

响应示例 状态码： 200 成功返回200 { "articles" : [ { "id" : "案例Id", "code" : "案例编码", "name" : "案例名称", "url" : "案例链接", "product_type_id" : "产品类型Id", "business_type_id" : "业务类型Id", "problem_type_id" : "问题类型Id" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 incident_detail_info IncidentDetailInfoV2 object 工单详情 表5 IncidentDetailInfoV2 参数 参数类型 描述 xcustomer_id String 子用户id 最小长度：0 最大长度：64 xcustomer_name String 子用户名称 最小长度：0 最大长度：256 status Integer 状态 0：待受理 1：处理中 2：待确认结果 3：已完成 4：已撤销 12：无效 17： 待反馈 最小值：0 最大值：20 judgement String 评价内容 最小长度：0 最大长度：400 incident_id String 工单id 最小长度：0 最大长度：64 business_type_name String 问题类型名称 最小长度：0 最大长度：64 incident_type_name String 工单类型名称 最小长度：0 最大长度：64 customer_id String 客户id 最小长度：0 最大长度：64 dc_name String 区域名称 最小长度：0 最大长度：64 simple_description String 简要描述 最小长度：0 最大长度：2000 source_name String 来源名称 最小长度：0 最大长度：64 create_time String 创建时间 最小长度：0 最大长度：32 message_list Array of IncidentMessageV2 objects 留言列表 数组长度：0 - 65535 incident_satisfaction Array of IncidentSatisfactionV2Do objects 满意度列表 数组长度：0 - 65535 severity_name String 严重性名称 最小长度：0 最大长度：64 business_ownership Integer 业务归属 0华为云 1BP伙伴 2ISV 最小值：0 最大值：2 resolve_time Long 解决时间 最小值：0 最大值：9223372036854775807 ext_info IncidentDetailExtInfoV2 object 工单附加信息 表6 IncidentMessageV2 参数 参数类型 描述 type Integer 类型，0客户留言 1华为工程师留言 最小值：0 最大值：1 replier String 回复人ID 最小长度：0 最大长度：64 content String 留言内容 最小长度：0 最大长度：5000 message_id String 留言id 最小长度：0 最大长度：64 replier_name String 回复人名称 最小长度：0 最大长度：256 create_time String 创建时间 最小长度：0 最大长度：32 is_first_message Integer 是否是第一条留言 最小值：0 最大值：1 accessory_list Array of SimpleAccessoryV2 objects 附件列表 数组长度：0 - 65535 表7 SimpleAccessoryV2 参数 参数类型 描述 accessory_id String 附件id 最小长度：0 最大长度：64 file_actual_name String 附件实际名称 最小长度：0 最大长度：256 表8 IncidentSatisfactionV2Do 参数 参数类型 描述 value Integer 满意度总分数 最小值：0 最大值：65535 satisfaction_id Integer 满意度分类id 最小值：0 最大值：9999 satisfaction_value Integer 满意度的值 最小值：0 最大值：65535 satisfaction_name String 满意度分类名称 最小长度：0 最大长度：32 per_value Integer 每格的分数 最小值：0 最大值：65535 sat_category_id String 满意度维度id 最小长度：0 最大长度：32 sat_category_name String 满意度维度名称 最小长度：0 最大长度：32 表9 IncidentDetailExtInfoV2 参数 参数类型 描述 area_code String 国家码 最小长度：0 最大长度：16 remind_mobile String 提醒手机 最小长度：0 最大长度：32 remind_mail String 提醒邮箱 最小长度：0 最大长度：256 contact_type String 联系方式类型 最小长度：0 最大长度：1 remind_time String 提醒时间 最小长度：0 最大长度：32 cc_email String 抄送邮箱 最小长度：0 最大长度：5000 commodity_id String ISV商品id 最小长度：0 最大长度：64

响应示例 状态码： 200 response of 200 { "incident_detail_info" : { "incident_id" : "123", "business_type_name" : "123", "incident_type_name" : "123", "customer_id" : "123", "xcustomer_id" : "123", "xcustomer_name" : "123", "dc_name" : "123", "simple_description" : "123", "status" : 1, "judgement" : "123", "message_list" : [ { "type" : 0, "replier" : "test", "message_id" : "test", "content" : "test", "replier_name" : "test", "create_time" : "test", "is_first_message" : 0, "accessory_list" : [ { "accessory_id" : "test", "file_actual_name" : "test" } ] } ], "incident_satisfaction" : [ { "value" : 1, "satisfaction_value" : 1, "satisfaction_id" : 1, "satisfaction_name" : "test", "per_value" : 1, "sat_category_id" : "test", "sat_category_name" : "test" } ], "severity_name" : "test", "business_ownership" : 1, "resolve_time" : "test", "ext_info" : [ { "area_code" : "test", "remind_mobile" : "test", "remind_mail" : "test", "contact_type" : "test", "remind_time" : "test", "cc_email" : "test", "commodity_id" : "test" } ], "source_name" : "123", "create_time" : "123" } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32

响应示例 状态码： 200 成功返回200 { "auth_detail_list" : [ { "account" : "root", "auth_detail_id" : 123, "password" : "123456", "port" : 22 }, { "account" : "root", "auth_detail_id" : 123, "password" : 123456, "port" : 1234 } ], "auth_effective_time" : 1592795931000, "auth_expire_time" : 1592795931000, "group_id" : "123456", "agency_id" : "123456" }

请求示例 PUT https://{endpoint}/v2/servicerequest/authorizations/Auth-123456?group_id=123 { "auth_detail_list" : [ { "auth_detail_id" : 123, "port" : 80, "account" : "test", "password" : "test" } ], "auth_effective_time" : 123, "auth_expire_time" : 123, "group_id" : "test", "agency_id" : "test" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32 表3 请求Body参数 参数 是否必选 参数类型 描述 auth_detail_list 否 Array of TenantAgreeAuthDetailV2 objects 授权详情列表 数组长度：0 - 6 auth_effective_time 否 Long 授权生效时间 最小值：0 最大值：9223372036854775807 auth_expire_time 否 Long 授权到期时间 最小值：0 最大值：9223372036854775807 group_id 否 String 组id 最小长度：0 最大长度：64 agency_id 否 String 委托id 最小长度：0 最大长度：64 表4 TenantAgreeAuthDetailV2 参数 是否必选 参数类型 描述 port 否 Integer 端口 最小值：1 最大值：65535 account 否 String 账号 最小长度：0 最大长度：64 password 否 String 密码 最小长度：0 最大长度：10240 auth_detail_id 是 Long 授权详情id 最小值：-9223372036854775808 最大值：9223372036854775807

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：5000 X-Language 否 String 语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。 会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。 最小长度：1 最大长度：32 X-Time-Zone 否 String 环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度：1 最大长度：32