云服务器内容精选
-
响应示例 { "stateCode":"0", "errorMessage":null, "result":{ "data":[{ "agentId":7521, "agentName":"liXX", "agentAccount":"188XXXX6100", "deputyAgentId":null, "deputyAgentUserId":null, "deputyAgentName":null, "deputyAgentAccount":null, "tenantId":886, "signSiteCode":"质检作业对象-01", "signSiteName":"质检作业对象-01", "userId":25773, "playUserId":25797, "channelId":202912, "channelName":"北京-XXXX-20200723S-质检位置-01", "createdBy":25797, "creationDate":"2020-09-11T07:16:54.000+0000", "createName":"韩XX", "chatjid":"186XXX@saasgroupchat.isdp-saas-sit.test.xxxx.com", "customerName":"XXXX;", "city":null, "province":"北京", "country":null, "taskId":591795, "taskName":"北京-XXXX-20200723S-质检位置-01", "projectNo":"20200723", "projectName":"20200723S", "adminRegion":null, "adminRegionName":null, "partner":null, "udf1":null, "udf3":null, "adminOrganization":null, "adminOrganizationName":null }], "pos":0, "total_count":1 } }
-
响应参数 参数 类型 描述 agentId int 坐席ID agentName String 坐席名称 agentAccount String 坐席账号 deputyAgentId int 副坐席ID deputyAgentUserId int 副坐席USERID deputyAgentName String 副坐席名称 deputyAgentAccount String 副坐席账号 tenantId int 租户ID signSiteCode String 作业对象编号 signSiteName String 作业对象名称 userId int 用户ID playUserId int 直播USERID channelId int 视频通道 channelName String 通道名称 createdBy int 创建人 creationDate Date 创建时间 createName String 创建人名字 chatjid int IM消息号 customerName String 客户名称 city String 城市 taskId int 任务Id taskName String 任务编码 projectNo String 项目编码 projectName String 项目名称 adminRegion String 行政区域 adminRegionName String 行政区 域名 字 partner String 分包商 udf3 String 作业类型 adminOrganization String 行政组织 adminOrganizationName String 行政组织名称
-
请求参数 参数 类型 是否必填 描述 page.start int 是 开始行数 page.count int 是 每页总数 taskId int 是 任务ID taskName String 是 任务名称 projectNo String 是 项目编码 projectName String 是 项目名称 udf3 String 是 作业类型 customer_name Array 必填 客户名称 city Array 是 国家 province Array 是 省份 country Array 是 城市 adminOrganization String 是 行政组织 adminOrganizationName String 是 行政组织名字
-
调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为 IAM 的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
-
请求消息 请求参数 表1 请求参数 参数 是否必选 参数类型 取值范围 描述 action 是 String 64 操作(cancel、close、press、delete) actionDesc 否 String 400 操作描述 caseId 是 String 32 工单Id 具体ID请参见查询工单列表获取的工单ID。 请求示例 { "action": "cancel", "actionDesc": "test", "caseId": "TT201801010000" }
-
请求消息 请求参数 表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- }
-
请求消息 请求参数 表1 参数说明 参数 是否必选 参数类型 取值范围 描述 searchKey 否 String 16 工单简要描述模糊查询。 caseId 否 String 32 工单编号模糊查询。 subCustomerName 否 String 32 IAM用户名模糊查询。 startTime 否 String N/A 查询工单开始时间。 时间格式例如:2019-05-22 03:30:52 endTime 否 String N/A 查询工单结束时间。 时间格式例如:2019-05-22 03:30:52 status 否 Integer N/A 状态 0:待受理 1:处理中 2:待确认结果 3:已完成 4:已撤销 查询全部传空 pageNo 否 Integer N/A 当前页,不传默认为1。 pageSize 否 Integer N/A 每页数量,取值范围:1-100,不传默认为10。 请求示例 searchKey=华为云&caseId=&startTime=&endTime=&subCustomerId=test&status=&pageNo=1&pageSize=10
-
状态码 表1 正常HTTP响应码 Status Code Description 200 OK 表2 异常HTTP响应码 Status Code Description 100 Continue 201 Created 202 Accepted 204 NO Content 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 409 Conflict 410 Gone 412 Precondition Failed 429 Too many requests 500 Internal Server Error 501 Not Implemented 503 Service Unavailable 父主题: 附录
-
操作步骤 获取IAM用户Token。 接口相关信息 URI格式:POST /v3/auth/tokens 详情请参见获取IAM用户Token(使用密码)。 请求示例 POST: https://{iam_endpoint}/v3/auth/tokens {endpoint}信息请从地区和终端节点获取。 Body: { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "domain": { "name": "domainname" }, "password": "****" } } }, "scope": { "project": { "id": "****" } } } } 响应Header中“X-Subject-Token”的值即为Token: X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX... 上传附件。 接口相关信息 URI格式: POST /v2/servicerequest/accessorys/json-format-content 详情请参见上传附件接口。 请求示例 POST https://osm.cn-south-1.myhuaweicloud.com/v2/servicerequest/accessorys/json-format-content Header: Content-Type: application/json X-Auth-Token: "Token" Body: { "accessory_name": "filename", "accessory_from": "incident", "upload_type": 0, "accessory_data": "Base64 XXXXX" } 响应示例 { "accessory_id": "accessory_id" } 调用创建工单接口创建工单。 接口相关信息 URI格式: POST /v2/servicerequest/cases 详情请参见创建工单。 请求示例 POST https://osm.cn-south-1.myhuaweicloud.com/v2/servicerequest/cases Header: Content-Type: application/json X-Auth-Token: "Token" Body: { "business_type_id": "business_type_id", "product_category_id": "product_category_id", "incident_sub_type_id": "1", "source_id": "83aeb0f2834c4df49826c781d32a963e", "simple_description": "test", "remind_time": "0", "region_id": "cn-test-1", "area_code": "86", "extends_map": { }, "extension_map": { }, "accessory_ids": [ "accessory_id" // 这里的id用第三步上传附件返回的id,//如果没有附件,不要传accessory_ids这个参数 ] } 响应示例 { "incident_id": "TS-123456" } 调用查询接口,查看工单的详情和进展。 接口相关信息 URI格式: GET /v2/servicerequest/cases/{case_id} 详情请参见查询工单详情接口。 请求示例 GET https://osm.cn-south-1.myhuaweicloud.com/v2/servicerequest/cases/TT-123456 Header: Content-Type: application/json X-Auth-Token: “Token” 响应示例 { "incident_detail_info": { "xcustomer_name": "test", "status": 0, "incident_id": "TT-123456", "business_type_name": "活动规则咨询", "customer_id": "customer_id", "dc_name": "华南-广州", "simple_description": "123", "source_name": "用户中心", "create_time": "2020-12-25T09:24:18Z", "message_list": [ { "type": 0, "replier": "", "content": "123", "message_id": "", "replier_name": "", "create_time": "2020-12-25T09:24:18Z", "is_first_message": 0, "accessory_list": [ { "accessory_id": "", "file_actual_name": "test.jpg" } ] } ], "incident_satisfaction": [ ], "is_authorized": 0, "resolve_time": 0, "business_ownership": 0, "ext_info": { "area_code": "", "remind_mobile": "", "remind_mail": "", "contact_type": "0,1,2", "remind_time": "0", "cc_email": "" } } } Status 0表示待受理。
-
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不同,使用时请注意。
-
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....
-
请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的帐号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的ID,获取方法请参见获取项目ID。 scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源,详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
-
请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
-
请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
-
请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
更多精彩内容
CDN加速
GaussDB
文字转换成语音
免费的服务器
如何创建网站
域名网站购买
私有云桌面
云主机哪个好
域名怎么备案
手机云电脑
SSL证书申请
云点播服务器
免费OCR是什么
电脑云桌面
域名备案怎么弄
语音转文字
文字图片识别
云桌面是什么
网址安全检测
网站建设搭建
国外CDN加速
SSL免费证书申请
短信批量发送
图片OCR识别
云数据库MySQL
个人域名购买
录音转文字
扫描图片识别文字
OCR图片识别
行驶证识别
虚拟电话号码
电话呼叫中心软件
怎么制作一个网站
Email注册网站
华为VNC
图像文字识别
企业网站制作
个人网站搭建
华为云计算
免费租用云托管
云桌面云服务器
ocr文字识别免费版
HTTPS证书申请
图片文字识别转换
国外域名注册商
使用免费虚拟主机
云电脑主机多少钱
鲲鹏云手机
短信验证码平台
OCR图片文字识别
SSL证书是什么
申请企业邮箱步骤
免费的企业用邮箱
云免流搭建教程
域名价格