应用管理与运维平台 ServiceStage应用管理与运维平台 ServiceStage

计算
弹性云服务器 ECS
云耀云服务器 HECS
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机 CPH
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
内容分发网络 CDN
存储容灾服务 SDRS
弹性文件服务 SFS
云服务器备份 CSBS
云硬盘备份 VBS
数据快递服务 DES
专属企业存储服务
智能边缘
智能边缘云 IEC
EI 企业智能
EI安视服务
AI开发平台ModelArts
数据湖治理中心 DGC
数据仓库服务 GaussDB(DWS)
企业级AI应用开发专业套件 ModelArts Pro
数据湖探索 DLI
华为HiLens
云搜索服务 CSS
数据接入服务 DIS
表格存储服务 CloudTable
数据湖工厂 DLF
图引擎服务 GES
推荐系统 RES
文字识别 OCR
内容审核 Moderation
图像识别 Image
图像搜索 ImageSearch
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
数据可视化 DLV
视频接入服务 VIS
自然语言处理 NLP
语音交互服务 SIS
知识图谱 KG
医疗智能体 EIHealth
可信智能计算服务 TICS
园区智能体 CampusGo
实时流计算服务 CS
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
IoT物联网
全球SIM联接 GSL
设备发放 IoTDP
IoT开发者服务
IoT边缘 IoTEdge
IoT数据分析
路网数字化服务 DRIS
开发与运维
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
软件开发平台 DevCloud
开源镜像站 Mirrors
视频
媒体处理 MPC
视频点播 VOD
视频直播 Live
实时音视频 SparkRTC
管理与部署
统一身份认证服务 IAM
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云审计服务 CTS
云日志服务 LTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
专属云
专属计算集群 DCC
专属分布式存储服务 DSS
域名与网站
域名注册服务 Domains
云速建站 CloudSite
企业协同
华为云WeLink
会议
ISDP
解决方案
全栈专属服务
高性能计算 HPC
SAP
游戏云
混合云灾备
快视频
华为工业云平台 IMC
价格
价格原则
成本优化最佳实践
昇腾
昇腾MindX SDK (20.3)
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
容器交付流水线 ContainerOps
应用服务网格 ASM
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
容器批量计算 BCE
云原生服务中心 OSC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
文档数据库服务 DDS
分布式数据库中间件 DDM
数据复制服务 DRS
数据管理服务 DAS
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
云数据库 GaussDB (for openGauss)
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
应用中间件
应用管理与运维平台 ServiceStage
分布式缓存服务 DCS
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
消息通知服务 SMN
微服务引擎 CSE
云性能测试服务 CPTS
区块链服务 BCS
API网关 APIG
应用魔方 AppCube
分布式消息服务RocketMQ版
多云高可用服务 MAS
可信跨链数据链接服务 TCDAS
企业应用
云桌面 Workspace
云解析服务 DNS
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
ROMA API
鸿源云道
华为乾坤云服务
安全与合规
Web应用防火墙 WAF
漏洞扫描服务 VSS
企业主机安全 HSS
容器安全服务 CGS
数据加密服务 DEW
数据库安全服务 DBSS
态势感知 SA
云堡垒机 CBH
SSL证书管理 SCM
云证书管理服务 CCM
管理检测与响应 MDR
数据安全中心 DSC
威胁检测服务 MTD
DDoS防护 ADS
云防火墙 CFW
应用信任中心 ATC
安全技术与应用
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
智能协作
IdeaHub
企业网络
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
废弃-华为乾坤安全云服务
云通信
语音通话 VoiceCall
消息&短信 MSGSMS
隐私保护通话 PrivateNumber
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
云生态
云市场
鲲鹏
昇腾
合作伙伴中心
华为云学院
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
网站备案
支持计划
专业服务
合作伙伴支持计划
更新时间:2021/10/18 GMT+08:00
分享

批量查询微服务实例

功能介绍

实例注册后可以根据微服务字段条件批量发现多个微服务的实例。

调试

您可以在API Explorer中调试该接口。

URI

POST /v4/{project_id}/registry/instances/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户子项目的唯一标识。字符长度为1~64。

表2 Query参数

参数

是否必选

参数类型

描述

type

String

操作,目前仅有“query”,表示查询

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-domain-name

String

租户帐号名称。

X-consumer_id

String

微服务消费者的微服务唯一标识。

X-Auth-Token

String

用户Token。

表4 请求Body参数

参数

是否必选

参数类型

描述

services

Array of FindService objects

查询服务信息结构体。

instances

Array of FindInstance objects

查询实例信息结构体。

表5 FindService

参数

是否必选

参数类型

描述

service

DependencyKey object

依赖关系条目。

rev

String

客户端缓存的版本号。

表6 DependencyKey

参数

是否必选

参数类型

描述

environment

String

development|testing|acceptance|production

appId

String

应用app唯一标识。

serviceName

String

微服务名称

表7 FindInstance

参数

是否必选

参数类型

描述

instance

HeartbeatSetElement object

微服务实例请求结构体。

rev

String

客户端缓存的版本号。

表8 HeartbeatSetElement

参数

是否必选

参数类型

描述

serviceId

String

微服务id

instanceId

String

微服务实例id

响应参数

状态码: 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

map<string, 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

允许失败次数,不允许小于0。

表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

详细定位信息。

请求示例

GET https://{endpoint}/v4/{project_id}/registry/instances/action

{
  "services" : [ {
    "service" : {
      "appId" : "TestApp",
      "serviceName" : "helloworld1"
    },
    "rev" : "1.0.0"
  }, {
    "service" : {
      "appId" : "TestApp",
      "serviceName" : "helloworld2"
    },
    "rev" : "1.0.0"
  } ]
}

响应示例

状态码: 200

查询成功。

{
  "services" : {
    "failed" : [ {
      "indexes" : [ 0 ],
      "error" : {
        "errorCode" : "string",
        "errorMessage" : "string",
        "detail" : "string"
      }
    } ],
    "notModified" : [ 0 ],
    "updated" : [ {
      "index" : 0,
      "rev" : "string",
      "instances" : [ {
        "instanceId" : "string",
        "serviceId" : "string",
        "version" : "string",
        "hostName" : "string",
        "endpoints" : [ "string", "string" ],
        "status" : "string",
        "null" : null,
        "healthCheck" : {
          "mode" : "string",
          "port" : 0,
          "interval" : 0,
          "times" : 0
        },
        "dataCenterInfo" : {
          "name" : "string",
          "region" : "string",
          "availableZone" : "string"
        },
        "timestamp" : "string",
        "modTimestamp" : "string"
      } ]
    } ]
  },
  "instances" : {
    "failed" : [ {
      "indexes" : [ 0 ],
      "error" : {
        "errorCode" : "string",
        "errorMessage" : "string",
        "detail" : "string"
      }
    } ],
    "notModified" : [ 0 ],
    "updated" : [ {
      "index" : 0,
      "rev" : "string",
      "instances" : [ {
        "instanceId" : "string",
        "serviceId" : "string",
        "version" : "string",
        "hostName" : "string",
        "endpoints" : [ "string", "string" ],
        "status" : "string",
        "null" : null,
        "healthCheck" : {
          "mode" : "string",
          "port" : 0,
          "interval" : 0,
          "times" : 0
        },
        "dataCenterInfo" : {
          "name" : "string",
          "region" : "string",
          "availableZone" : "string"
        },
        "timestamp" : "string",
        "modTimestamp" : "string"
      } ]
    } ]
  }
}

状态码: 400

{
  "errorCode" : "string",
  "errorMessage" : "string",
  "detail" : "string"
}

状态码: 500

{
  "errorCode" : "string",
  "errorMessage" : "string",
  "detail" : "string"
}

状态码

状态码

描述

200

查询成功。

400

错误的请求。

500

服务内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品