华为云用户手册

  • 基本概念 帐号 用户注册云平台时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 云平台的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 同样在我的凭证下,您可以查看项目ID。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • 响应参数 状态码: 200 删除成功。 状态码: 404 表3 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。
  • 响应参数 状态码: 204 删除成功。 状态码: 404 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 响应参数 状态码: 200 表9 响应Body参数 参数 参数类型 描述 services BatchFindResult object 批量查询结果结构体。 instances BatchFindResult object 批量查询结果结构体。 表10 BatchFindResult 参数 参数类型 描述 failed Array of FindFailedResult objects 查询失败结果结构体。 notModified Array of integers 与请求数组对应的索引集合。 updated Array of FindResult objects 查询结果结构体列表。 表11 FindFailedResult 参数 参数类型 描述 indexes Array of integers 与请求数组对应的索引集合。 error Error object 异常错误结构体。 表12 Error 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 表13 FindResult 参数 参数类型 描述 index Integer 与请求数组对应的索引。 rev String 服务端返回集合版本,如跟客户端缓存版本号一致,则instances为空。 instances Array of MicroServiceInstance objects 实例列表。 表14 MicroServiceInstance 参数 参数类型 描述 instanceId String 实例id,唯一标识。创建实例,instanceId由service-center产生。 serviceId String 微服务唯一标识,创建实例时,以url里面的为准,不用这里的serviceId。 version String 微服务版本号。 hostName String 主机信息。 endpoints Array of strings 访问地址信息。 status String 实例状态:UP、DOWN、STARTING、OUTOFSERVICE。默认值UP。 properties Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小为1字节。 healthCheck HealthCheck object 健康检查信息。 dataCenterInfo DataCenterInfo object 数据中心信息。 timestamp String 实例创建时间戳,自动生成。 modTimestamp String 更新时间。 表15 HealthCheck 参数 参数类型 描述 mode String 心跳模式push/pull。 port Integer 端口。 interval Integer 心跳间隔(秒),当值小于5秒时,按5秒注册。 times Integer 最大尝试请求次数。 表16 DataCenterInfo 参数 参数类型 描述 name String 区域名称。 region String 区域。 availableZone String 可用区。 状态码: 400 表17 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表18 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求示例 查询应用ID为default,微服务名称为test的微服务的所有实例。 POST https://{endpoint}/v4/{project_id}/registry/instances/action?type=query{ "services": [ { "service": { "environment": "", "appId": "default", "serviceName": "test" }, "rev": "0" } ]}
  • 响应示例 状态码: 200 查询成功。 { "services": { "updated": [ { "index": 0, "rev": "0feb784798bca7b2fb4de8351578c4437b516c4b", "instances": [ { "instanceId": "79cdaf47cacf43a5b2b4185527da2255", "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "endpoints": [ "rest:127.0.0.1:8080" ], "hostName": "hostNameTest", "status": "UP", "properties": { "engineID": "30c263e5-2eac-4da1-9c72-5abb9ac94550", "engineName": "cse-fkln1-HA" }, "healthCheck": { "mode": "push", "interval": 30, "times": 3 }, "timestamp": "1650546183", "modTimestamp": "1650546183", "version": "1.0.0" } ] } ] }}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-consumerId 否 String 微服务消费者的微服务唯一标识。 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 services 两个参数至少必须选择一个。 Array of FindService objects 查询服务信息结构体。 instances Array of FindInstance objects 查询实例信息结构体。 表5 FindService 参数 是否必选 参数类型 描述 service 是 DependencyKey object 依赖关系条目。 rev 否 String 客户端缓存的版本号,用于判断本地缓存和服务中心微服务的差异。 首次传值0。 若传入的rev值与当前的微服务的rev一致,则返回notModified;若不一致,则返回updated信息。 下次请求若需要传入rev,则该值为当前返回body体中的updated中的rev的值 。 表6 DependencyKey 参数 是否必选 参数类型 描述 environment 是 String 环境信息:development、testing、acceptance、production。 appId 是 String 应用app唯一标识。 serviceName 是 String 微服务名称。 表7 FindInstance 参数 是否必选 参数类型 描述 instance 否 HeartbeatSetElement object 微服务实例请求结构体。 rev 否 String 客户端缓存的版本号, 客户端缓存的版本号,用于判断本地缓存和服务中心微服务实例的差异。 首次传值0。 若传入的rev值与当前的微服务实例的rev一致,则返回notModified;若不一致,则返回updated信息。 下次请求若需要传入rev,则该值为当前返回body体中的updated中的rev的值 。 表8 HeartbeatSetElement 参数 是否必选 参数类型 描述 serviceId 否 String 微服务id。 instanceId 否 String 微服务实例id。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表3 Query参数 参数 是否必选 参数类型 描述 label 否 String 按label过滤项导出,格式为:{标签key}:{标签value}。 match 否 String 对label过滤项的匹配选项,如果值为exact,表示严格匹配,包括label个数和内容相等;不填表示包含匹配。 revision 否 Integer 配置的版本号。 用于判断本地缓存配置和配置管理中心的配置差异。 首次传值0。 若传入的revision值与当前配置的revision一致,则返回304状态码,无body体返回;若不一致,则返回当前配置和revision信息。 下次请求若需要传入revision,则该值为当前返回body体中的update_revision 。
  • 响应示例 状态码: 200 查询成功。 { "total": 1, "data":[{ "id": "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "key": "string", "labels": { "key1": "value1", "key2": "value2" }, "value": "string", "value_type": "text", "status": "enabled", "create_time": 1623139038, "update_time": 1623139038, "create_revision": 13, "update_revision": 13 }]}
  • 响应示例 状态码: 200 查询成功,则返回serviceId或者schemaId。 { "providers": [ { "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "appId": "default", "serviceName": "test", "version": "1.0.0", "description": "this is a test", "level": "BACK", "status": "UP", "properties": { "test": "test" }, "timestamp": "1650543950", "modTimestamp": "1650544411" } ]}
  • URI GET /v4/{project_id}/registry/microservices/{consumer_id}/providers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值:default。 consumer_id 是 String 消费者的服务id。 表2 Query参数 参数 是否必选 参数类型 描述 noSelf 否 Integer 是否取消返回自依赖的关系,0表示不返回自依赖关系,1表示返回自依赖关系。 sameDomain 否 Integer 是否取消返回共享服务的关系,0表示不返回共享服务,1表示返回。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 providers MicroService object 微服务信息。 表5 MicroService 参数 参数类型 描述 serviceId String 微服务唯一标识。字符长度为1~64。正则表达式为^.*$。 environment String 用于区分微服务环境,取值为:development、testing、acceptance、production。当配置为development、testing或acceptance时,可以通过批量上传schemas接口新增或者修改已存在的Schema;当配置为production时,则不可以新增或者修改Schema。默认值development。 appId String 应用App唯一标识。字符长度为1~160。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 serviceName String 微服务名称,同一个App要保证唯一。字符长度为1~128。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 version String 微服务版本号。字符长度为1~64。 正则表达式为^[0-9]$|^[0-9]+(.[0-9]+)$。 description String 微服务描述信息。字符长度不超过256。 level String 微服务层级:FRONT、MIDDLE、BACK。 registerBy String 微服务注册方式:SDK、PLATFORM、SIDECAR、UNKNOWN。 schemas Array of strings 微服务访问的契约内容。支持数字、字母,支持使用括号内字符(_-.)做连接符,长度1-160字节,数组长度最大100个契约。 status String 微服务状态:UP表示上线,DOWN表示下线。默认值UP。 timestamp String 微服务注册时间。 modTimestamp String 最后修改UTC时间。 framework Framework object 开发框架信息。 paths Array of ServicePath objects 服务路由信息。 properties Object 扩展属性。可以自定义KEY和相应的Value。 表6 Framework 参数 参数类型 描述 name String 微服务开发框架,默认值为UNKNOWN。 version String 微服务开发框架版本号。 表7 ServicePath 参数 参数类型 描述 Path String 路由地址。 Property Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 响应示例 状态码: 200 创建成功,返回配置信息。 { "id": "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "key": "string", "labels": { "key1": "value1", "key2": "value2" }, "value": "string", "value_type": "text", "status": "enabled", "create_time": 1623139038, "update_time": 1623139038, "create_revision": 13, "update_revision": 13,}
  • 请求示例 创建一条配置,其标签信息为: "key1": "value1", "key2": "value2"。 POST https://{endpoint}/v1/{project_id}/kie/kv{ "key": "String", "value": "String", "labels": { "key1": "value1", "key2": "value2", }, "status": "String", "value_type": "String"}
  • 响应示例 状态码: 200 查询成功 { "id": "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "key": "string", "labels": { "key1": "value1", "key2": "value2" }, "value": "string", "value_type": "text", "status": "enabled", "create_time": 1623139038, "update_time": 1623139038, "create_revision": 13, "update_revision": 13}
  • 响应示例 状态码: 200 查询成功。 { "instances": [ { "instanceId": "4098483294bb42d8b3c27eee0c166c1c", "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "endpoints": [ "rest:127.0.0.1:8080" ], "hostName": "hostNameTest", "status": "UP", "properties": { "engineID": "30c263e5-2eac-4da1-9c72-5abb9ac94550", "engineName": "cse-fkln1-HA" }, "healthCheck": { "mode": "push", "interval": 30, "times": 3 }, "timestamp": "1650545431", "modTimestamp": "1650545442", "version": "1.0.0" } ]}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-ConsumerId 否 String 微服务消费者的微服务唯一标识。 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。
  • URI GET /v4/{project_id}/registry/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值:default。 表2 Query参数 参数 是否必选 参数类型 描述 appId 是 String 应用app唯一标识。字符长度为1~160。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 serviceName 是 String 微服务名称。字符长度为1~128。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 tags 否 String Tag标签过滤,多个时逗号分隔。 正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$。 env 否 String 实例的环境信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MicroServiceInstance objects 实例列表。 表5 MicroServiceInstance 参数 参数类型 描述 instanceId String 实例id,唯一标识。创建实例,instanceId由service-center产生。 serviceId String 微服务唯一标识,创建实例时,以url里面的为准,不用这里的serviceId。 version String 微服务版本号。 hostName String 主机信息。 endpoints Array of strings 访问地址信息。 status String 实例状态:UP、DOWN、STARTING、OUTOFSERVICE。默认值UP。 properties Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。 healthCheck HealthCheck object 健康检查信息。 dataCenterInfo DataCenterInfo object 数据中心信息。 timestamp String 实例创建时间戳,自动生成。 modTimestamp String 更新时间。 表6 HealthCheck 参数 参数类型 描述 mode String 心跳模式push/pull。 port Integer 端口。 interval Integer 心跳间隔(秒),当值小于5秒时,按5秒注册。 times Integer 最大尝试请求次数。 表7 DataCenterInfo 参数 参数类型 描述 name String 区域名称。 region String 区域。 availableZone String 可用区。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求示例 修改配置ID为8a9e6a5d-8d65-48fb-a40c-5150c8479da8的配置值为this is a test,设置其配置状态为enabled。 PUT https://{endpoint}/v1/{project_id}/kie/kv/8a9e6a5d-8d65-48fb-a40c-5150c8479da8{ "value": "this is a test", "status": "enabled"}
  • 响应示例 状态码: 200 修改成功,返回配置信息。 { "id": "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "key": "string", "labels": { "key1": "value1", "key2": "value2" }, "value": "this is a test", "value_type": "text", "status": "enabled", "create_time": 1623139038, "update_time": 1623139038, "create_revision": 13, "update_revision": 13,}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 kie SingleKieInfo 一条配置信息。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_message String 错误信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 value 是 String 配置的value。 status 否 String 配置的状态。
  • URI PUT /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$。获取方法请参考查询所有微服务信息。 instance_id 是 String 微服务实例唯一标识。字符长度不超过64位, 正则表达式为^[A-Za-z0-9_.-]*$。获取方法请参考根据service_id查询微服务实例。 表2 Query参数 参数 是否必选 参数类型 描述 value 是 String 实例状态。UP表示在线、OUTOFSERVICE表示摘机、STARTING表示正在启动、DOWN表示下线、TESTING表示拨测。
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 开通云消息服务(KooMessage) 云消息服务(KooMessage)需要先开通才能订购和使用,当前仅支持华为云主帐号开通。 您可以自助开通免审核。 进入KooMessage官网首页。 登录KooMessage控制台。 KooMessage服务只向通过认证的企业提供开通,如还未完成企业用户认证,请单击“去认证企业用户”进行认证。 勾选“我已阅读并同意《KooMessage服务使用声明》”,单击“立即开通”。 图1 开通KooMessage服务 开通成功后进入控制台首页,且后续直接登录使用无需再开通。
  • 购买套餐包 该解决方案需进行如下资源规划。 开通KooMessage服务后,默认自动开通按需计费。购买按需套餐包后,优先扣除按需套餐包额度,超出部分按量计费。 请谨慎选择所需购买的套餐包,购买成功后无法申请退款。 登录KooMessage控制台。 单击界面上的“购买套餐包”,进入到“购买KooMessage套餐包”页面。 参考表1填写各参数。 表1 套餐包基本信息 参数类型 参数项 说明 示例 智能信息 信息类型 选择需要的信息类型 通知发送 套餐 选择需要的套餐 10万条套餐 购买数量 选择需要的数量 1 填写完成后,页面下方会出现“配置费用”,确认无误后,单击“去支付”进入到“购买KooMessage套餐包”页面。 在“购买KooMessage套餐包”页面查看“云服务订单”,选择支付方式。 单击“确认付款”。 若开启操作保护,则会弹出“身份验证”对话框,进行身份验证。根据界面提示进行验证,并单击“确定”。 界面提示订单支付成功,购买完成。
  • 方案架构 智能短信操作流程如图1所示。 图1 操作流程图 登录KooMessage控制台。 进行智能信息企业认证。 在“企业备案”界面可上传并查看审核状态,通过后可以使用智能信息。 创建短信应用。 短信应用是用户使用华为公有云短信服务的载体。 创建短信签名。 短信签名是短信发送中的署名,能代表发送者身份标识的字段。 创建短信模板。 短信模板是指短信发送方发送短信时使用的内容模板。 创建智能信息模板。 在“智能信息配置”界面查看公共模板,创建我的模板,进行域名管理。 发送智能信息。 单击要发送的模板,选择发送信息,填写相关内容,上传发送文件后,即可进行发送。
  • 添加事件源 OBS桶及函数创建以后,可以为函数添加事件源,添加OBS事件源是通过创建OBS触发器实现的,步骤如下。 用户进入fss_examples_image_watermark函数详情页,在“触发器”页签,单击“创建触发器”,弹出“创建触发器”界面。 触发器类型选择“存储(OBS)”,填写触发器配置信息,如图1所示。 桶选择创建OBS桶中创建的“hugb-bucket-input”桶。 事件选择“Post”、“Put”。 图1 创建OBS触发器 单击“确定”,完成触发器创建。 OBS触发器创建以后,当有图片上传或更新至hugb-bucket-input桶时,生成事件,触发函数执行。 父主题: 使用函数为图片打水印
  • 创建功能函数 创建实现日志提取功能的函数,将示例代码包上传。创建过程请参考创建函数,运行时语言选择“Python2.7”,委托名称选择创建委托中的“LtsOperation”。 函数实现的功能是:将收到的日志事件数据进行base64解码,然后提取出包含“WRN”、“WARN”、“ERR”或“ERROR”关键字的告警日志,将此级别的日志投递至OBS桶中集中存储。可根据您的业务日志的具体内容配置相应的日志提取条件。
共100000条