华为云用户手册

  • 如何选择区域? 选择区域时,您需要考虑以下几个因素: 地理位置 一般情况下,建议就近选择靠近您或者您的目标用户的区域,这样可以减少网络时延,提高访问速度。不过,在基础设施、BGP网络品质、资源的操作与配置等方面,中国大陆各个区域间区别不大,如果您或者您的目标用户在中国大陆,可以不用考虑不同区域造成的网络时延问题。 在除中国大陆以外的亚太地区有业务的用户,可以选择“中国-香港”、“亚太-曼谷”或“亚太-新加坡”区域。 在非洲地区有业务的用户,可以选择“南非-约翰内斯堡”区域。 在欧洲地区有业务的用户,可以选择“欧洲-巴黎”区域。 资源的价格 不同区域的资源价格可能有差异,请参见华为云服务价格详情。
  • 资产存储计费说明 资产存储计费说明,如表1所示。 表1 资产存储计费说明 资产存储 计费说明 免费存储空间 MetaStudio服务免费赠送每个租户5GB资产存储空间,用于上传各类音视频、图片等素材。如果租户需要更多的存储空间,请购买单独的资产管理包月产品。 定制形象模型存储 基于MetaStudio服务定制生成的形象模型,其所包含的音色模型所占存储空间,暂不计入租户资产存储计费中。 定制视频资产存储 基于MetaStudio服务定制生成的视频资产,6个月以内不计入资产存储空间计费;满6个月以后,参与计费。 资产存储计费说明 资产只要没有被彻底删除,均需要进行租户的资产存储空间计费。即使资产处于冻结状态,或在回收站时,也需参与计费。
  • 资产冻结说明 资产冻结说明,如表2所示。 表2 资产冻结说明 场景 操作说明 服务冻结租户资产 MetaStudio服务对租户资产内容的风险有一定连带责任。如果服务接收到资产内容投诉,按照国家相关部门要求,会冻结违规违规资产。情节严重的,还会冻结租户的全部资源。 被冻结的资产不能用作内容生成的素材。租户可以删除被冻结的资产或者申请解冻资产。 用户申请解冻资产 用户可以通过申诉的方式,申请解冻资产,解冻后资产会恢复至解冻前的状态。 如果处于回收站中的资产被冻结,解冻后,其状态会恢复至被删除前的状态。
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 gatewayId String 网关的ID。 pluginConfig Object 传递给插件的配置。 name String routeName String 路由的名称。 routeDestinationName String 目标路由的名称。 dubbo Dubbo object dubbo 服务的信息。 表8 Dubbo 参数 参数类型 描述 service String 服务名。 version String 版本号。 group String 分组。 methods Array of DubboMethod objects dubbo方法列表。 表9 DubboMethod 参数 参数类型 描述 serviceMethod String 服务方法。 headersAttach String 附加请求头。 httpMethods Array of strings http 方法。 httpPath String http 路径。 params Array of DubboMethodParam objects dubbo 方法参数。 表10 DubboMethodParam 参数 参数类型 描述 paramKey String 参数键。 paramSource String 参数来源。 paramType String 参数类型。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM -Token Accept 否 String 该字段内容填为 "application/json" 表3 请求Body参数 参数 是否必选 参数类型 描述 gatewayId 否 String 网关的ID。 pluginConfig 否 Object 传递给插件的配置。 name 否 String routeName 否 String 路由的名称。 routeDestinationName 否 String 目标路由的名称。 dubbo 否 Dubbo object dubbo 服务的信息。 表4 Dubbo 参数 是否必选 参数类型 描述 service 否 String 服务名。 version 否 String 版本号。 group 否 String 分组。 methods 否 Array of DubboMethod objects dubbo方法列表。 表5 DubboMethod 参数 是否必选 参数类型 描述 serviceMethod 否 String 服务方法。 headersAttach 否 String 附加请求头。 httpMethods 否 Array of strings http 方法。 httpPath 否 String http 路径。 params 否 Array of DubboMethodParam objects dubbo 方法参数。 表6 DubboMethodParam 参数 是否必选 参数类型 描述 paramKey 否 String 参数键。 paramSource 否 String 参数来源。 paramType 否 String 参数类型。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为 "application/json;charset=UTF-8"。 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 微服务引擎专享版的实例ID。 X-Enterprise-Project-ID 是 String 企业项目ID。 x-environment 否 String 所属环境。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name String 治理策略名称。 selector GovSelector object 治理策略下发范围。 spec Object 治理策略定义内容。 表4 GovSelector 参数 参数类型 描述 environment String 所属环境。 app String 所属应用。 service String 可选,治理下发到微服务级别。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 detail String 详细定位信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 imagePullPolicy String 拉取OCI镜像的行为 枚举值: UNSPECIFIED_POLICY IfNotPresent Always imagePullSecret String 拉取OCI 镜像的凭据 phase String 确定插件将在过滤器链中的何处注入。 枚举值: UNSPECIFIED_PHASE AUTHN AUTHZ STATS pluginConfig Object 传递给插件的配置。 pluginName String 插件名。 priority Integer 插件的调用优先级。 sha256 String 用于校验插件和容器的校验和。 url String 插件或容器的下载地址。 verificationKey String 校验值。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM-Token Accept 否 String 该字段内容填为 "application/json" 表3 请求Body参数 参数 是否必选 参数类型 描述 imagePullPolicy 否 String 拉取OCI镜像的行为 枚举值: UNSPECIFIED_POLICY IfNotPresent Always imagePullSecret 否 String 拉取OCI 镜像的凭据 phase 否 String 确定插件将在过滤器链中的何处注入。 枚举值: UNSPECIFIED_PHASE AUTHN AUTHZ STATS pluginConfig 否 Object 传递给插件的配置。 pluginName 否 String 插件名。 priority 否 Integer 插件的调用优先级。 sha256 否 String 用于校验插件和容器的校验和。 url 否 String 插件或容器的下载地址。 verificationKey 否 String 校验值。
  • 响应示例 状态码: 200 查询成功。 { "instances": [ { "instanceId": "8540bb8b693c4ad1a7fb6a756c415244", "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": "1650545035", "modTimestamp": "1650545035", "version": "1.0.0" } ] }
  • 响应参数 状态码: 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 详细定位信息。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-ConsumerId 否 String 微服务消费者的微服务唯一标识。 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的ServiceComb引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取ServiceComb引擎专享版用户Token。
  • URI GET /v4/{project_id}/registry/microservices/{service_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$。获取方法请参考查询所有微服务信息。 表2 Query参数 参数 是否必选 参数类型 描述 tags 否 String Tag标签过滤,多个时逗号分隔。 正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$。
  • 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-Schema-Summary String 微服务契约的摘要。 表4 响应Body参数 参数 参数类型 描述 schema String 契约内容。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 响应示例 状态码: 200 查询成功,如果summary存在,则header里面的X-Schema-Summary的value为该schema对应的摘要。 { "schema" : "---\nswagger: \"2.0\"\ninfo:\n version: \"1.0.0\"\n title: \"swagger definition for com.service.provider.controller.ProviderImpl\"\n x-java-interface: \"cse.gen.springmvc.provider.provider.ProviderImplIntf\"\nbasePath: \"/provider\"\nconsumes:\n- \"application/json\"\nproduces:\n- \"application/json\"\npaths:\n /helloworld:\n get:\n operationId: \"helloworld\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n required: true\n type: \"string\"\n responses:\n 200:\n description: \"response of 200\"\n schema:\n type: \"string\"\n" }
  • URI GET /v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$。获取方法请参考查询所有微服务信息。 schema_id 是 String 契约的id。获取方法请参考查询微服务的所有契约。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的ServiceComb引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取ServiceComb引擎专享版用户Token。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 升级的ServiceComb引擎专享版ID。 name String 升级的ServiceComb引擎专享版名称。 jobId Integer ServiceComb引擎专享版执行的任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Enterprise-Project-ID 否 String 企业项目id。 如果不配置此参数,则默认企业项目为“default”,ID为0。 表3 请求Body参数 参数 是否必选 参数类型 描述 version 是 String 升级到的ServiceComb引擎专享版的版本号。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的ServiceComb引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取ServiceComb引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 properties 否 Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为 "application/json;charset=UTF-8"。 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 微服务引擎专享版的实例ID。 X-Enterprise-Project-ID 是 String 企业项目ID。 x-environment 否 String 所属环境。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 service MicroService object 微服务信息。 表4 MicroService 参数 参数类型 描述 serviceId String 微服务唯一标识。字符长度为1~64。正则表达式为^.*$。 environment String 用于区分微服务环境,取值为development、testing、acceptance、production。 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。 枚举值: UP DOWN timestamp String 微服务注册时间。 modTimestamp String 最后修改UTC时间。 framework Framework object 开发框架信息。 paths Array of ServicePath objects 服务路由信息。 表5 Framework 参数 参数类型 描述 name String 微服务开发框架,默认值为UNKNOWN。 version String 微服务开发框架版本号。 表6 ServicePath 参数 参数类型 描述 Path String 路由地址。 Property Object 微服务扩展属性,可以自定义KEY和相应的Value。长度最小1字节。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 响应示例 状态码: 200 查询成功。 { "service": { "serviceId": "819706e21b7173306797d19922ce4231441c17c5", "appId": "default", "serviceName": "SERVICECENTER", "version": "2.4.8", "level": "BACK", "schemas": [ "servicecenter.grpc.api.ServiceCtrl", "servicecenter.grpc.api.ServiceInstanceCtrl" ], "status": "UP", "timestamp": "1616426688", "modTimestamp": "1616426688", "environment": "development" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的ServiceComb引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取ServiceComb引擎专享版用户Token。
  • URI PUT /v1/{project_id}/nacos/v1/console/namespaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识。字符长度为1~64。 表2 Query参数 参数 是否必选 参数类型 描述 namespace 是 String 命名空间ID。 namespace_show_name 是 String 命名空间名,支持非@、#、$、%、^、&、*,不超过128个字符。 namespace_desc 是 String 命名空间描述,不超过256个字符。
  • 响应示例 状态码: 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表示返回。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若ServiceComb引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的ServiceComb引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取ServiceComb引擎专享版用户Token。
  • 响应参数 状态码: 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 详细定位信息。
共100000条