云服务器内容精选

  • 响应示例 { "stateCode": "0", "errorMessage": null, "result": { "data": [ { "agentCode": "0e626733-07d8-45af-af23-aff287b118b8", "productType": null, "deliveryScene": null, "businessType": null, "agentAccount": "111111111", "agentName": "111111111", "type": "0", "areaName": "", "appName": "isdp-qc-server", "entityName": "agent", "cityId": null, "createName": "小七", "lastUpdateName": "小七", "agentId": 17813, "tenantId": 886, "userId": 307457, "createdBy": 277881, "lastUpdatedBy": 277881, "creationTimestamp": 1616486693402, "lastUpdateTimestamp": 1616486693402, "onlineStatus": 1, "isArea": 0, "deleteFlag": 0, "capacity": 1, "creationDate": "2021-03-23T08:04:54.000+00:00", "lastUpdateDate": "2021-03-23T08:05:32.000+00:00", } ], "pos": 0, "total_count": 340, "entityName": null, },}
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 domain 否 String 主题名称 最小长度:0 最大长度:200 top 否 Integer 返回匹配度最高的数据条数 最小值:1 最大值:1000
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:32 error_msg String 错误描述 最小长度:0 最大长度:32 qa_pairs Array of SimpleQaPair objects 语料列表 数组长度:0 - 65535 表5 SimpleQaPair 参数 参数类型 描述 question String 问题 最小长度:0 最大长度:65535 domain String 主题 最小长度:0 最大长度:200 qa_pair_id String 语料Id 最小长度:0 最大长度:64
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 question 是 String 用户输入问题 最小长度:1 最大长度:1000 top 否 Integer 返回匹配度最高的数据条数 最小值:1 最大值:10 domains 否 Array of strings 问答领域 最小长度:1 最大长度:200 数组长度:0 - 200
  • 请求参数 表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 表3 响应Body参数 参数 参数类型 描述 case_agreement AgreementVO object 附件限制信息 表4 AgreementVO 参数 参数类型 描述 id String 协议id 最小长度:1 最大长度:11 agreement_name String 协议名称 最小长度:1 最大长度:128 agreement_type String 协议类型 最小长度:1 最大长度:32 agreement_type_name String 协议类型名称 最小长度:1 最大长度:128 content String 内容 最小长度:1 最大长度:2147483647 version Integer 版本 最小值:0 最大值:2147483647
  • 响应示例 状态码: 200 成功返回200 { "case_agreement" : { "id" : "123", "agreement_name" : "新建工单", "agreement_type" : "0", "agreement_type_name" : "新建工单", "content" : "content", "version" : "1.0.0" }}
  • 请求参数 表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 表4 请求Body参数 参数 是否必选 参数类型 描述 reject_reason 否 String 拒绝理由 最小长度:1 最大长度:300 group_id 否 String 组id 最小长度:1 最大长度:64
  • URI PUT /v2/servicerequest/authorizations/{authorization_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 authorization_id 是 String 授权id 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 action_id 否 String 操作id,reject,cancel 最小长度:1 最大长度:16
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 themes Array of RelationTheme objects 关联主题列表 数组长度:0 - 65535 error_code String 错误码 最小长度:0 最大长度:32 error_msg String 错误描述 最小长度:0 最大长度:32 product_type_id String 产品类型Id 最小长度:0 最大长度:64 theme_name String 主题名称 最小长度:0 最大长度:200 表4 RelationTheme 参数 参数类型 描述 theme_name String 主题 最小长度:0 最大长度:65535 relation_type String NON_PRIMARY: 主主题 PRIMARY: 枚举值: NON_PRIMARY PRIMARY
  • 请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 accessoryName 是 String 512 附件名 accessoryData 是 byte[] - 附件内容 文件最大为2M,文件格式限制为JPG, JPEG, BMP, PNG, GIF, TXT, DOC, DOCX, RAR, ZIP, PDF, XLS, XLSX accessoryFrom 是 String 32 附件来源 message(留言) incident(事件) feedback(意见反馈) 请求示例 {------WebKitFormBoundarynm7SNCD8ZcLOjQHw Content-Disposition: form-data; name="accessoryData"; filename="Chrysanthemum.jpg" Content-Type: image/jpeg ------WebKitFormBoundarynm7SNCD8ZcLOjQHw Content-Disposition: form-data; name="accessoryName" Chrysanthemum.jpg ------WebKitFormBoundarynm7SNCD8ZcLOjQHw Content-Disposition: form-data; name="accessoryFrom" incident ------WebKitFormBoundarynm7SNCD8ZcLOjQHw Content-}
  • URI GET /v2/irobot/themes/convert 表1 Query参数 参数 是否必选 参数类型 描述 product_type_id 否 String 产品类型Id 最小长度:1 最大长度:64 product_type_name 否 String 产品类型名称 最小长度:0 最大长度:200 product_type_short_name 否 String 产品类型缩写 最小长度:0 最大长度:200
  • 请求参数 表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
  • 基本概念 帐号 用户注册时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并用来进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 父主题: 使用前必读
  • URI POST /v2/servicerequest/cases/{case_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 case_id 是 String 工单id 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 action_id 是 String 具体操作 cancel,close,press,delete 最小长度:1 最大长度:64