云服务器内容精选

  • 步骤五:调用服务 向已创建的“通用图像搜索”服务实例中添加数据,可以调用添加数据API实现,搜索数据、检查数据、更新数据、删除数据等操作。具体操作如下: 新建请求,请求方式为修改“POST”,按要求填写URL。 例如:服务部署在“华北-北京四”,添加数据API的请求URL为“https://mms.cn-north-4.myhuaweicloud.com/v2/{project_id}/mms/{service_name}/data/add”。 选中“Headers”配置项,复制Token值到“X-Auth-Token”。 登录我的凭证,查询属于“华北-北京四”的项目ID,替换URI中的{project_id}。 使用已创建的通用图像搜索服务实例名称“imagesearch_test”,替换URI中的{service_name}。 单击“Body”配置项,按照如下图中所示内容填写参数。关于body体中其他参数说明,请参考添加数据API。 图3 body参数 单击右上角“Send”按钮发送请求,查看添加数据结果。
  • 基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区(Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 父主题: 使用前必读
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。 AK/SK签名认证通过API网关向下层服务发送请求时,必须使用AK、SK对请求进行签名,参见API签名指南。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 使用子账号AK/SK的时候需要在header中增加字段X-Domain-Id,填入用户的账号ID。
  • 调用接口步骤 如何调用接口完成Token认证。 发送“POST https://IAM的Endpoint/v3/auth/tokens”,获取IAM的Endpoint及消息体中的区域名称,请参见地区和终端节点。 请求内容示例如下: { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名 "password": "password", //密码 "domain": { "name": "domainname" //账户名 } } } }, "scope": { "project": { "name": "cn-north-1" //图像搜索所属区域信息 } } } } 请将以上示例代码中的斜体字替换为实际所需要的内容,详情请参考《统一身份认证服务API参考》。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 调用业务接口,在请求消息头中增加“X-Auth-Token”,“X-Auth-Token”的取值为步骤2中获取的Token。
  • 获取AK/SK 注册并登录图像搜索管理控制台。 在页面右上方用户名的下拉列表中,单击“我的凭证”。在“我的凭证”界面,单击“管理访问密钥”。 单击“新增访问密钥”,弹出“新增访问密钥”对话框。 输入当前用户的登录密码,并通过邮箱或者手机进行验证,输入对应的验证码,单击“确定”,下载访问密钥。 在统一身份服务中创建的用户,如果创建时未填写邮箱或者手机号,则只需校验登录密码。 为防止访问密钥泄露,建议您将其保存到安全的位置。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 username、domainname 的获取请参考获取账号名和账号ID。password为用户密码。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 当调用API网关Silvan接口时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。
  • 调用API获取项目ID 项目ID通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为GET https://{iam-endpoint}/v3/projects,其中{iam-endpoint}为IAM的终端节点。可以从地区和终端节点处获取。 响应示例如下,例如图像搜索服务部署的区域为"cn-north-4",响应消息体中查找“name”为"cn-north-4",其中projects下的“id”即为项目ID。 { "projects": [{ "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "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" } }
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 例如对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxx为project的name,获取方法请参见获取用户名、账号名和项目name。 scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 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": { "name": "xxxxxxxxxx" //替换为实际project的name } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如所示需要添加公共消息头到请求中。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型(格式)。 是 application/json X-Auth-Token 用户Token。 用户Token,也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 使用Token认证时必选 - x-sdk-date 请求的发生时间 格式为(YYYYMMDD'T'HHMMSS'Z')。取值为当前系统的GMT时间 使用AK/SK认证时必选 20160629T101459Z Authorization 签名认证信息。 该值来源于请求签名结果。 使用AK/SK认证时必选 - Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 使用AK/SK认证时必选 - 公有云API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见API签名指南。 例如,对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求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),拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。REST API支持的方法如下表2所示。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 例如,在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求示例 搜索商品图像,使用图像BASE64编码 POST https://{endpoint}/v2/{project_id}/mms/{service_name}/search { "search_type" : "CATEGORY", "image_base64" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAA...", "custom_tags" : { "brand" : [ "HUAWEI" ] }, "custom_num_tags" : { "year" : { "from" : 2020, "to" : 2022 } } }
  • 响应示例 状态码: 200 成功响应示例 { "result" : "success", "data" : { "items" : [ { "id" : "electronics_01", "score" : 1, "source" : { "desc" : "天地纵横自然", "custom_tags" : { "brand" : "HUAWEI" }, "custom_num_tags" : { "year" : 2022 } } } ], "search_info" : { "total_num" : 10, "return_num" : 1, "search_time" : 512 }, "image_info" : { "box" : "26,223,771,704", "category" : 11, "category_name" : "electronics", "objects" : [ { "box" : "26,223,771,704", "category" : 11, "category_name" : "electronics" }, { "box" : "55,66,420,315", "category" : 0, "category_name" : "others" } ] } } } 状态码: 400 失败响应示例 { "error_code" : "MMS.0003", "error_msg" : "Invalid parameter: custom_tags" }
  • 通用搜索 功能介绍 通用图像搜索,旨在针对入库的图像数据提供通用场景下的相同或相似图像搜索能力,目前包括图像检索图像、关键词检索、文本检索图像。用户在开启相应的检索子能力后,可以分别使用图像、关键词和文本对入库的图像进行搜索。 应用场景 相同或相似图像搜索:从海量图像库中快速搜索相同或相似的的图像,可以应用于图像推荐、审核等业务中。 图文跨模态搜索根据文本描述从图像库中搜索与其语义一致的图像,可以应用于素材查找、图库管理等业务中。 父主题: 功能介绍
  • 服装商品搜索 搜索类型 服装商品搜索目前仅支持CATEGORY一种搜索类型。 CATEGORY: 类目检索。 高级配置 服装商品搜索允许用户对服务实例进行高级配置,以满足业务应用的差异化需求。 商品图像配置 添加图像商品数量: 单张图像允许的最大添加商品数量,默认为1,取值范围为[1, 3]。该配置对有效并发影响较大,需要根据实际情况合理配置。 搜索图像商品数量: 搜索图像返回的最大检测商品数量,默认为3,取值范围为[1, 5]。搜索时会直接使用最显著商品进行搜索,同时返回图像中所有商品用于后续精准搜索。 请求高阶参数 服装商品搜索允许用户在调用API接口时传递高阶参数,以满足业务应用的差异化需求。 CATEGORY 针对类目检索的搜索类型,服务实例具有如下高阶请求参数: 添加数据API do_det: 是否进行目标检测,默认为true。 box: 目标矩形框左边,如给定则不进行目标检测,直接使用该box作为目标。 do_cls: 是否进行对象分类,默认为true。 category: 对象类目,如给定则不进行对象分类,直接使用该category作为类目。 { "do_det": true, "box": "50,100,200,300", "do_cls": true, "category": 1 } 搜索API do_det: 是否进行目标检测,默认为true。 box: 目标矩形框左边,如给定则不进行目标检测,直接使用该box作为目标。 do_cls: 是否进行对象分类,默认为true。 category: 对象类目,如给定则不进行对象分类,直接使用该category作为类目。 collapse_key: 去重标签名,如给定则会基于其对搜索结果进行去重。 { "do_det": true, "box": "50,100,200,300", "do_cls": true, "category": 1, "collapse_key": "spu_id" } 响应高阶字段 服装商品搜索的请求响应存在高阶字段,以满足业务应用的潜在感知需求。 CATEGORY 针对类目检索的搜索类型,服务实例具有如下高阶响应字段: 添加数据API image_info: 添加图像数据的相关信息。 { "image_info": { "objects": [ { "box": "135,489,1117,1341", "category": 1, "category_name": "top" } ] } } 搜索API image_info: 搜索图像的相关信息。 { "image_info": { "box": "135,489,1117,1341", "category": 1, "category_name": "top", "objects": [ { "category_name": "top", "box": "135,489,1117,1341", "category": 1 }, { "category_name": "others", "box": "373,99,661,468", "category": 0 } ] } } 商品类目 服装商品搜索支持的商品类目详见表2。 表2 服装商品类目表 类目ID 英文描述 中文描述 0 others 其他商品 1 top 上装 2 bottom 裤子 3 skirt 裙装 4 underwear 内衣