华为云用户手册

修订记录 表1 修订记录 发布日期 修订记录 2024-01-24 1、新增自定义设置。 2、新增查看日志。 2024-01-17 1、新增拓扑。 2、Opentelemtry支持组件拓扑图、调用链详情时序图。 3、配置告警页面优化。 4、APM调用链筛选时间段优化。 5、新增对比。 2023-12-11 新增Profiler性能分析。 2023-11-30 1、新增实例。 2、新增采集状态。 3、新增远程过程调用。 2023-10-30 1、新增自定义统计。 2、链路追踪支持OpenTelemetry。 2023-08-30 1、前端监控支持vue能力和sourcemap能力。 2、新增“订购APM企业版”。 2023-08-08 1、优化图表显示，新增“图表拆分&联动”功能。 2、指标页面增加导出功能。 3、APM页面优化，菜单栏宽度可以自动调节。 2023-07-05 优化前端监控章节，指定API链路追踪列表新增“API请求状态”字段。 2023-06-30 新增应用列表、创建应用、创建子应用配置应用、子应用、应用监控配置、支持跨账号管理性能数据。 2023-05-15 新增PHP应用接入。 2023-04-13 新增开始监控Node.js应用、开始监控GO应用、开始监控Python应用。 控制台界面优化。 2023-03-31 前端监控支持配置告警策略、链路追踪支持配置告警策略。 2023-02-28 新增前端监控、链路追踪、查看Druid连接池监控、查看Hikari连接池监控、配置url监控项章节的表格中，增加Url自动规整说明。 2023-01-17 新增资源标签管理、推荐模板、数据脱敏。 “事务跟踪”更新为URL跟踪。 2022-04-26 新增探针统计，支持查看租户使用的探针数量。 2022-04-11 第一次正式发布。

JavaAgent安装脚本 表1 JavaAgent安装脚本 JavaAgent脚本名称 下载地址 apm_agent_install.sh 下载 sha256:327561e1c4232b18321cce8ae4682b0cd85661ea4e1f231e3d40db65be993565 apm_agent_install2.sh 下载 sha256:dd65c227ab2e08bfd838906430a7469be464b3f376031f1e7865cc41b7072c7d

中国大陆外节点分布 大区 节点分布（以华为内部业务划分区域） 亚洲 中国香港、中国澳门、中国台湾、日本、韩国、越南、印度、印尼、泰国、菲律宾、新加坡、马来西亚、柬埔寨、老挝、吉尔吉斯斯坦、文莱、缅甸、尼泊尔、孟加拉、蒙古、斯里兰卡、哈萨克斯坦、格鲁吉亚、亚美尼亚、乌兹别克斯坦、塞浦路斯、阿塞拜疆 欧洲 英国、德国、法国、荷兰、西班牙、意大利、 爱尔兰、瑞典、比利时、奥地利、波兰、罗马尼亚、白俄罗斯、葡萄牙、土耳其、摩尔多瓦、保加利亚、拉脱维亚、瑞士、捷克、匈牙利、卢森堡、希腊、克罗地亚、塞尔维亚、芬兰 中东&非洲 阿联酋、沙特、巴基斯坦、卡塔尔、阿曼、科威特、巴林、伊拉克、南非、埃及、肯尼亚、坦桑尼亚、马达加斯加、吉布提、毛里求斯、加纳、安哥拉、尼日利亚、约旦、也门、以色列、塞内加尔 北美洲 美国、加拿大、墨西哥 大洋洲 澳大利亚、新西兰、斐济 南美洲 巴西、智利、阿根廷、秘鲁、哥伦比亚、厄瓜多尔

身份认证与访问控制 身份认证 用户可以通过控制台、API和SDK三种方式访问华为云CDN，其本质都是通过CDN提供的REST API接口进行请求。CDN的接口均需要通过认证鉴权才能访问，详情请参考API认证鉴权。 访问控制 CDN对接了统一身份认证服务（Identity and Access Management，IAM）服务，IAM是华为云提供权限管理的基础服务，可以帮助CDN服务安全地控制访问权限。通过IAM，可以将用户加入到一个用户组中，并用策略来控制他们对CDN资源的访问范围。IAM权限可以通过细粒度定义允许和拒绝的访问操作，以此实现CDN资源的权限访问控制。CDN资源的访问权限详情请参见CDN权限管理。 CDN支持配置防盗链功能，通过设置的过滤策略，对访问者身份进行识别和过滤，实现限制访问来源的目的。 CDN支持配置IP黑白名单功能，通过设置过滤策略，对用户请求IP地址进行过滤，从而限制访问来源。 CDN支持配置UA黑白名单功能，通过设置过滤策略，对用户请求使用的代理过滤，从而限制访问来源。 CDN支持配置URL鉴权功能，保护用户站点资源，防止资源被用户恶意下载盗用。 父主题： 安全

注意事项 可查询的时间跨度最长为31天，支持查看最近90天的历史数据。 如果查询的域名在所指定时间跨度范围内无数据，则流量/带宽趋势图中不会有数据展示。 最小统计粒度为5分钟，当查询跨度为8天及以上时，最小统计粒度为4小时。 本页面展示的数据是日志记录的流量数据，最终账单中的流量会上浮10%，上浮的是TCP/IP包头和TCP重传消耗的流量。 用量查询有1小时左右的时延。 支持导出将查询的数据详情。 支持按照标签、业务类型筛选域名。

风险操作 当您在CCE、ECS或BMS服务控制台直接操作ModelArts Lite k8s Cluster资源时，可能会导致资源池部分功能异常，下表可帮助您定位异常出现的原因，风险操作包括但不限于以下内容： 表1 操作及其对应风险 类型 操作 风险 集群 升级、修改、休眠集群、删除集群等。 可能影响ModelArts侧基本功能，包括但不限于资源池管理、节点管理、扩缩容、驱动升级等。 节点 退订、移除、关机、污点管理、修改登录密码、修改网络安全组、切换/重装操作系统等。 可能影响ModelArts侧基本功能，包括但不限于节点管理、扩缩容、驱动升级等。 网络 修改/删除集群关联网段。 影响ModelArts侧基本功能，包括但不限于节点管理、扩缩容、驱动升级等。 插件 升级、卸载gpu-beta插件。 可能导致NPU驱动使用异常。 升级、卸载huawei-npu插件。 可能导致NPU驱动使用异常。 升级、卸载volcano插件。 可能导致作业调度异常。 卸载ICAgent插件。 可能导致日志、监控功能异常。 helm 升级、回退、卸载os-node-agent。 可能影响节点故障检测。 升级、回退、卸载rdma-sriov-dev-plugin。 可能影响容器内使用RDMA网卡。 父主题： k8s Cluster资源使用

不同机型的对应的软件配套版本 表1 裸金属服务器 类型 卡类型 RDMA 操作系统 适用范围、约束 依赖插件 NPU ascend-snt9b roce 操作系统：EulerOS 2.10 64bit 内核版本：4.19.90-vhulk2211.3.0.h1543.eulerosv2r10.aarch64 架构类型：aarch64 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 集群转发模式：iptables|ipvs huawei-npu npu-driver volcano 插件版本匹配关系请见表3。 ascend-snt9b roce 操作系统：Huawei Cloud EulerOS 2.0 64bit 内核版本：5.10.0-60.18.0.50.r865_35.hce2.aarch64 架构类型：aarch64 集群类型：CCE Turbo 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：ENI 集群转发模式：iptables|ipvs ascend-snt9 roce 操作系统：EulerOS 2.8 64bit 内核版本：4.19.36-vhulk1907.1.0.h619.eulerosv2r8.aarch64 架构类型：aarch64 集群类型：CCE Standard|Turbo 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC|ENI 集群转发模式：iptables|ipvs GPU ascend-ant8-pcie80 roce 操作系统：EulerOS 2.10 64bit 内核版本：4.18.0-147.5.2.15.h1109.eulerosv2r10.x86_64 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 分布式训练时仅支持容器隧道网络 集群转发模式：iptables|ipvs gpu-beta gpu-driver rdma-sriov-dev-plugin 插件版本匹配关系请见表3。 nvidia-ant1 roce 操作系统：EulerOS 2.10 64bit 4.18.0-147.5.2.15.h1109.eulerosv2r10.x86_64 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 分布式训练时仅支持容器隧道网络 集群转发模式：iptables|ipvs nvidia-v100 roce|IB 操作系统：EulerOS 2.9 64bit（仅上海一p6|p6s规格使用） 内核版本：147.5.1.6.h1099.eulerosv2r9.x86_64 架构类型：x86 集群类型：CCE Standard| 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 分布式训练时仅支持容器隧道网络 集群转发模式：iptables|ipvs 操作系统：EulerOS 2.9 64bit（推荐） 内核版本：4.18.0-147.5.1.6.h841.eulerosv2r9.x86_64 架构类型：x86 表2 弹性云服务器 类型 卡类型 操作系统 适用范围 依赖插件 NPU ascend-snt3p-300i 操作系统：EulerOS 2.9 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC|ENI 集群转发模式：iptables|ipvs huawei-npu npu-driver volcano 插件版本匹配关系请见表3。 ascend-snt3 操作系统：EulerOS 2.5 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 集群转发模式：iptables|ipvs 操作系统：EulerOS 2.8 架构类型：arm 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 集群转发模式：iptables|ipvs GPU nvidia-v100-pcie32 操作系统：EulerOS 2.9 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 集群转发模式：iptables|ipvs gpu-beta gpu-driver rdma-sriov-dev-plugin 插件版本匹配关系请见表3。 nvidia-a30 操作系统：EulerOS 2.9 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 集群转发模式：iptables|ipvs ant1-pcie40 操作系统：EulerOS 2.9 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 集群转发模式：iptables|ipvs nvidia-t4 操作系统：EulerOS 2.9 架构类型：x86 集群类型：CCE Standard 集群版本：v1.23|v1.25 集群规模：50|200|1000|2000 集群网络模式：容器隧道网络|VPC 集群转发模式：iptables|ipvs 表3 插件版本与CCE集群版本适配关系 类别 插件名称 插件版本 适配CCE集群版本 适用范围、约束 插件功能描述 ccePlugin gpu-beta 1.2.29 v1.(23|25).* GPU 支持在容器中使用GPU显卡的设备管理插件。 1.2.15 v1.(23|25).* huawei-npu 1.2.5 v1.(23|25).* NPU 支持容器里使用huawei NPU设备的管理插件。 volcano 1.11.9 v1.(23|25).* NPU 基于Kubernetes的批处理平台。 1.7.1 v1.(23|25).* 1.4.2 v1.(23|25).* npuDriver npu-driver 6.4.0.2.220-23.0.rc2.2 6.4.0.3.220-23.0.rc2.3 6.4.0.4.220-23.0.rc3（推荐） 7.0.0.5.242-23.0.rc3 c78-21.0.2 c81-22.0.0.3 c82-22.0.2.100 c85-23.0.rc1 无约束 NPU 用于升级、回滚npu驱动。 helm rdma-sriov-dev-plugin 0.1.0 无约束 BMS、RDMA且非ascend-1980 用于支持容器里使用RDMA网卡。 memarts 3.23.6-r002 无约束 无约束 无约束 os-node-agent 6.2.0-20230925213538 无约束 无约束 OS插件，用于故障检测。 icAgent icagent default CCE默认安装当前适配版本 无约束 CCE基础组件，用于日志和监控。 gpuDriver gpu-driver gpu-driver与系统内核版本有关，请见表4。 用于升级、回滚gpu驱动，插件依赖gpu-beta版本。 表4 系统内核与gpu-driver配套关系 镜像版本 系统内核版本 适配CCE gpu-driver版本 EulerOS 2.10 4.18.0-147.5.2.15.h1109.eulerosv2r10.x86_64 v1.(23|25).* 容器隧道网络|VPC|ENI 515.65.01 470.182.03 470.57.02 4.18.0-147.5.2.5.h805.eulerosv2r10.x86_64 v1.(23|25).* 容器隧道网络|VPC|ENI 515.65.01 470.57.02 460.32.03 440.33.01 EulerOS 2.3 3.10.0-514.44.5.10.h193.x86_64 v1.(23|25).* 容器隧道网络|VPC 515.65.01 470.57.02 440.33.01 3.10.0-514.44.5.10.h254.x86_64 v1.(23|25).* 容器隧道网络|VPC 515.65.01 470.57.02 440.33.01 EulerOS 2.9 4.18.0-147.5.1.6.h841.eulerosv2r9.x86_64 v1.(23|25).* 容器隧道网络|VPC 515.65.01 470.182.03 470.57.02 440.95.01

什么是区域、可用区？ 区域和可用区用来描述数据中心的位置，您可以在特定的区域、可用区创建资源。 区域（Region）：从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区（AZ，Availability Zone）：一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 图1阐明了区域和可用区之间的关系。 图1 区域和可用区 目前，华为云已在全球多个地域开放云服务，您可以根据需求选择适合自己的区域和可用区。更多信息请参见华为云全球站点。

如何选择区域？ 选择区域时，您需要考虑以下几个因素： 地理位置 一般情况下，建议就近选择靠近您或者您的目标用户的区域，这样可以减少网络时延，提高访问速度。不过，在基础设施、BGP网络品质、资源的操作与配置等方面，中国大陆各个区域间区别不大，如果您或者您的目标用户在中国大陆，可以不用考虑不同区域造成的网络时延问题。 在除中国大陆以外的亚太地区有业务的用户，可以选择“中国-香港”、“亚太-曼谷”或“亚太-新加坡”区域。 在非洲地区有业务的用户，可以选择“南非-约翰内斯堡”区域。 在欧洲地区有业务的用户，可以选择“欧洲-巴黎”区域。 资源的价格 不同区域的资源价格可能有差异，请参见华为云服务价格详情。

资产存储计费说明 资产存储计费说明，如表1所示。 表1 资产存储计费说明 资产存储 计费说明 免费存储空间 MetaStudio服务免费赠送每个租户5GB资产存储空间，用于上传各类音视频、图片等素材。如果租户需要更多的存储空间，请购买单独的资产管理包月产品。 定制形象模型存储 基于MetaStudio服务定制生成的形象模型，其所包含的音色模型所占存储空间，暂不计入租户资产存储计费中。 定制视频资产存储 基于MetaStudio服务定制生成的视频资产，6个月以内不计入资产存储空间计费；满6个月以后，参与计费。 资产存储计费说明 资产只要没有被彻底删除，均需要进行租户的资产存储空间计费。即使资产处于冻结状态，或在回收站时，也需参与计费。

资产冻结说明 资产冻结说明，如表2所示。 表2 资产冻结说明 场景 操作说明 服务冻结租户资产 MetaStudio服务对租户资产内容的风险有一定连带责任。如果服务接收到资产内容投诉，按照国家相关部门要求，会冻结违规违规资产。情节严重的，还会冻结租户的全部资源。 被冻结的资产不能用作内容生成的素材。租户可以删除被冻结的资产或者申请解冻资产。 用户申请解冻资产 用户可以通过申诉的方式，申请解冻资产，解冻后资产会恢复至解冻前的状态。 如果处于回收站中的资产被冻结，解冻后，其状态会恢复至被删除前的状态。

仿真典型场景的按需计算用量及计费预估 订阅前，可参考仿真典型场景来识别按需计算的用量，结合单价从而预判每月消费金额。 依据仿真工程师日常工作时间识别每用户每月开展仿真前后处理工作的时长（小时），如表1所示。 表1 每用户使用仿真前后处理时长计算方法 每用户/月仿真工作天数 每用户/天仿真工作时长 每用户/月使用仿真前后处理 18天/月 5小时/天 90小时/月=18天/月*5小时/天 识别私有服务器的负载情况，计算每月提交仿真求解计算的核时数（核*时），如表2所示。 表2 每月仿真求解用量（核时与时长）的计算方法 私有服务器配置 每月计算天数 每天满负荷计算时长 每月提交仿真求解核时 每月提交仿真求解时长 8核 30天 8小时 1920核*时/月 = 8核私有服务器 * 30天/月 * 8小时满负荷计算/天 120小时/月 = 1920核*时 / 16核 上表“每月提交仿真求解时长”中“16核”表示云上计算任务提交时所选择的并行计算核数。 假设2名工程师订阅工业仿真工具链云服务及云商店配套工业仿真软件，则大致每月消费如表3所示。 表3 每月消费计算方法 商品 量纲 单价 计量数量 支出 华为云云官网：工业仿真工具链云服务 工业仿真云平台-X版本 用户/月 1200元 2人 2,400元 云原生仿真-X版本 用户/月 240元 2人 480元 工业仿真计算 仿真求解计算-X规格 核*时 0.6元 1920核*时 1,152元 仿真前后处理-X规格 小时 8.8元 120小时 1,056元 小计 5,088元 华为云云商店：某仿真软件 仿真前后处理-X规格 小时 60元 180小时 = 90小时*2人 10,800元 仿真求解计算-X规格 小时 78元 120小时 9,360元 小计 20,160元 总计 25,248元 以上表格中“商品”、“量纲”和“单价”请参考具体的商品定价清单。

计费场景 某用户于2023/03/18 15:30:00开通了工业仿真工具链云服务，订阅了工业仿真云平台（1用户）和云原生仿真（1用户），包月方式，按单价预付款，同时往账号中充值9000元。 随后每个工作日使用工业仿真计算的仿真求解计算-CPU计算服务|（CPU:Memory=1:4）对网格模型进行了1小时的计算，每次计算16核，每个工作日使用仿真前后处理计算|8核|32GB内存|4G显存对网格模型进行剖分、清理等操作2小时，3月18日到4月18日一共有20个工作日使用了按需服务，那么在3~4月份，该云服务总共产生了多少费用呢？

计费构成分析 根据规则，包周期的工业仿真云平台和云原生仿真在2023/03/18 15:30:00 ~ 2023/04/18 15:30:00期间为包年包月计费，工业仿真计算在2023/03/18 15:30:00 ~ 2023/04/18 15:30:00期间为按需计费。 按需计费 在2023/03/18 15:30:00 ~2023/04/18 15:30:00期间按照Computing.Solver.CPU.Ratio.4规格计费320核时，Computing.PrePostCloudApp.GPU.4规格计费40小时，费用计算如下： 由此可见，在3~4月份，该用户云服务器总共产生的费用为：1200+240+192+352=1984元。 重要：仿真计算时会用到了云商店的按需仿真软件，它的计量和收费在云商店执行。 如果账户充值不够，上述场景中，仅在开通后存入了100元，则会在按需服务的每个结算周期后检查，一旦100元消费完，则用户再也无法提交任何计算，已经在计算的会继续计算，但是其结果可能无法查看，需要充值后才可查看。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 创建的微服务引擎专享版ID。 name String 创建的微服务引擎专享版名称。 jobId Integer 微服务引擎专享版执行的任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_msg String 错误信息。 detail String 详细定位信息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误代码。 error_msg String 错误信息。 detail String 详细定位信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM-Token。 X-Enterprise-Project-ID 否 String 如果不带则默认企业项目为"default"，ID为"0"。 缺省值：0 表3 请求Body参数 参数 是否必选 参数类型 描述 authType 是 String authType安全认证类型，支持填写NONE和RBAC。

响应参数 状态码： 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。