华为云用户手册

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 dependencies 是 Arrayof objects 规则的集合，请参考表4。列表长度为1-100。 表4 MicroServiceDependency 参数 是否必选 参数类型 描述 consumer 是 Object 消费端微服务，具体参考DependencyMicroService。 providers 否 Array of objects 服务端微服务，具体参考DependencyMicroService。

URI PUT /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版，请填租户项目id，长度为1~64，获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版，请填固定值：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 详细定位信息。

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建并使用用户进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

响应参数 状态码： 200 表11 响应Body参数 参数 参数类型 描述 serviceId String 微服务唯一标识。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

请求示例 创建一个微服务的静态信息，其微服务名为test，微服务版本为1.0.0，rule的类型为白名单，实例的主机信息为instanceTest，访问地址为rest:127.0.0.1:8080。 POST https://{endpoint}/v4/{project_id}/registry/microservices { "service": { "appId": "default", "serviceName": "test", "version": "1.0.0", "description": "this is a test" }, "rules": [{ "ruleType": "WHITE", "attribute": "tag_123", "pattern": "aaa" }], "instances": [{ "hostName": "instanceTest", "endpoints": ["rest:127.0.0.1:8080"] }], "tags": { "test_tag1": "test_tag1", "test_tag2": "test_tag2", "test_tag3": "test_tag3" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 service 是 MicroService object 微服务信息。 rules 否 Array of Rule objects 黑白名单信息。 instances 否 Array of MicroServiceInstance objects 实例信息。 tags 否 Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 表4 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 微服务访问契约内容的外键ID，数组长度最大100个契约。 status 否 String 微服务状态，UP表示上线，DOWN表示下线，默认值UP。 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字节。 表7 Rule 参数 是否必选 参数类型 描述 ruleId 否 String 自定义ruleId。 ruleType 否 String rule类型：WHITE或者BLACK。 attribute 否 String 如果是tag_xxx开头，则按Tag过滤attribute属性，否则，则按"serviceId", "AppId", "ServiceName", "Version", "Description", "Level", "Status"过滤。 pattern 否 String 匹配规则，正则表达式，长度1到64。 description 否 String rule描述。 timestamp 否 String 只有获取rule时返回使用，创建rule的时间。 modTimestamp 否 String 更新时间。 表8 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 更新时间。 表9 HealthCheck 参数 是否必选 参数类型 描述 mode 是 String 心跳模式： push或者pull。 port 否 Integer 端口。 interval 是 Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。 times 是 Integer 最大尝试请求次数。 表10 DataCenterInfo 参数 是否必选 参数类型 描述 name 是 String 区 域名 称。 region 是 String 区域。 availableZone 是 String 可用区。

请求示例 查询微服务serviceId，指定的查询条件是请求类型为microservice，应用id为default，微服务名称为service，微服务版本为1.0.0。 GET https://{endpoint}/v4/{project_id}/registry/existence?type=microservice&appId=default&serviceName=service&version=1.0.0

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Schema-Summary String 契约的摘要。 表5 响应Body参数 参数 参数类型 描述 serviceId String 查询实体为服务时，返回服务ID。 schemaId String 查询实体为契约时，返回契约ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

URI GET /v4/{project_id}/registry/existence 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版，请填租户项目id，长度为1~64，获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版，请填固定值：default。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 请求类型： microservice schema 说明： 若type为microservice，参数env、appId、serviceName、version必填。 若type为schema，参数serviceId、schemaId必填。 env 否 String 微服务的环境信息：development、testing、acceptance、production。 appId 是 String 资源类型为microservice时需传入应用app唯一标识。 字符长度为1~160。正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 serviceName 是 String 资源类型为microservice时需传入微服务名称。 字符长度为1~128正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 version 是 String 资源类型为microservice时需传入微服务版本。 字符长度为1~64。正则表达式为^[0-9]$|^[0-9]+(.[0-9]+)$。 serviceId 是 String 资源类型为schema时需传入微服务唯一标识。 字符长度为1~64。正则表达式为^.*$。 schemaId 是 String 资源类型为schema时需传入schema唯一标识。 字符长度为1~160。正则表达式为^[a-zA-Z0-9]{1,160}$|^[a-zA-Z0-9][a-zA-Z0-9_-.]{0,158}[a-zA-Z0-9]$。

URI DELETE /v3/{project_id}/cas/applications/{application_id}/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 environment_id 是 String 环境ID。获取方法，请参考获取所有环境。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 泳道总数。 swimlanes Array of objects 泳道列表，请参考表5。 表5 swimlanes 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE：基线泳道。 GRAY：灰度泳道。 tag String 泳道标签，根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE：开启路由。 DISABLED：关闭路由。 rule_match_mode String 路由规则匹配模式。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。 ALL：匹配所有的规则。 ANY：匹配任一规则。 rules Array of objects 路由规则。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。请参考表6。 weight Integer 泳道流量权重。范围在0-100之间。 当泳道组灰度类型为基于流量，即gray_release_type为WEIGHT时生效。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表6 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER，即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT：精确匹配。 PREFIX：前缀匹配。 REGEX：正则匹配。

响应示例 { "swimlanes": [ { "id": "8c6274b9-113e-4066-9b1c-320fe5ae327b", "name": "baselane", "swimlane_group_id": "13c73b95-ec0f-4e11-8901-d1e3c9142d75", "type": "BASE", "tag": "base", "weight": 100, "route_status": "ENABLE", "swimlane_group": { "routeInGroupTags": null, "gateways": [ { "id": "6b44bcf9-99e9-46f4-9ab5-7670456073fc", "name": "microGateway-pyy-0127-1", "target_services": [ { "id": "e882070c-7d02-4db1-8b84-619ee88f1a25", "host": "unit-provider-all..wulumuqi.servicecomb", "name": "unit-provider-all" } ], "engine_id": "b4032a08-b09d-47e4-a01f-596906df6f55" } ], "id": "13c73b95-ec0f-4e11-8901-d1e3c9142d75", "name": "test-wqd", "gray_release_type": "WEIGHT", "description": "111" } } ], "count": 1 }

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应示例 { "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "engine_type": "servicecomb" } ], "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067" } ], "id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "name": "test", "gray_release_type": "WEIGHT", "description": "test", "project_id": "578ac30b81034b89a7255b3af26db9c9", "creator": "test_user", "create_time": 1726623793113, "update_time": 1726623793113, "gateway_engine_ids": [ "d68a5ca7-b5b6-4917-a464-0adef94b8067" ] }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息 表3 响应参数 参数 参数类型 描述 count Integer 泳道组总数。 swimlaneGroups Array of objects 泳道组列表，请参考表4。 表4 swimlaneGroups 参数 参数类型 描述 description String 泳道组的描述。 gray_release_type String 灰度发布类型。 WEIGHT：基于流量比例进行全链路灰度。 CONTENT：基于内容进行全链路灰度。 gateways Array of objects 流量网关入口，请参考表5。 name String 泳道组的名称。 id String 泳道组的ID。 gateway_engine_ids Array of String 网关ID列表。 creator String 创建者。 create_time String 创建时间。 update_time String 更新时间 project_id String 租户项目ID。获取方法，请参考获取项目ID。 表5 gateways 参数 参数类型 描述 engine_id String 引擎ID。 id String 网关ID。 name String 网关名称。 target_services Array of objects 目标服务列表。请参考表6。 表6 target_services 参数 参数类型 描述 host String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成，以点号（.）分隔。 例如，unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称，testing为unit-controller微服务所在环境名，test-application为unit-controller微服务所属应用名称，servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 name String 目标服务名称。 id String 目标服务ID。 engine_id String 引擎ID。 engine_type String 引擎类型。 servicecomb：ServiceComb引擎。 nacos：注册配置中心。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应示例 { "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", "name": "dev-env", "description": "develop environment", "project_id": "bf8523d898b64e4eb956e3be3555ca16", "enterprise_project_id": "0", "deploy_mode": "virtualmachine", "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", "resources": [ { "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80", "type": "ecs", "name": "ecs-test" } ], "creator": "ss-test", "create_time": 1578984198394, "update_time": 1578984198394, "labels": null }

响应消息 表3 响应参数 参数 参数类型 描述 id String 环境ID。 name String 环境名称。 description String 环境描述。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 deploy_mode String 环境类型。 vpc_id String 虚拟私有云ID。 creator String 环境创建人。 create_time Integer 环境创建时间。 update_time Integer 环境修改时间。 labels Array of objects 标签，可使用标签管理服务通过标签过滤资源，请参考表4。 resources Array of objects 资源，请参考表5。 表4 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。 表5 resources 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 资源类型。 vpc，虚拟私有云。 eip，弹性公网IP。 elb，弹性负载均衡。 cce，云容器引擎。 ecs，弹性云服务器。 as，弹性伸缩组。 cse，微服务引擎。 dcs，分布式缓存服务。 rds，云数据库。

ServiceComb错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 分类 状态码 错误码 错误信息 描述 处理措施 公共错误码 400 400001 Invalid parameter(s) 非法参数 根据错误提示中的规则，修改提示中的参数。 404 404001 ErrRecoudNotExists 该资源不存在 输入正确的查找条件。 409 409001 ErrRecordAlreadyExists 该资源已存在 请勿创建相同的记录。 500 500003 Internal server error 内部错误 内部错误请联系运维支持。 微服务 400 400002 ErrUnhealthy 服务处于不健康状态 请稍后重试或联系技术支持工程师。 400010 Micro-service already exists 服务已存在 修改创建微服务body体中的serviceId或微服务描述信息。 400011 ErrUnavailableBackend 没有可提供的后台实例 请稍后重试或联系技术支持工程师。 400012 Micro-service does not exist 服务不存在 请输入有效的serviceId。 400013 Micro-service has deployed instance(s) 无法删除该微服务，该微服务已部署实例 请先将实例下线，再删除微服务；或强制删除微服务（url中添加query参数“force=true”）。 400014 Undefined schema id schemaId不存在 请输入有效的schemaId。 400015 Not allowed to modify schema schema不允许修改 该schema已注册，不支持修改。 400016 Schema does not exist schema不存在 请先注册schema再查询。 400017 Instance does not exist 实例不存在 请输入有效的instanceId。 400018 ErrTagNotExists 标签不存在 通常出现在查询接口，表明标签不存在，业务根据返回值做恰当后续处理。 400019 ErrRuleAlreadyExists 规则已经存在 重复创建规则，通常可以忽略该错误。 400020 ErrBlackAndWhiteRule 错误的黑白名单 根据错误提示修改参数。 400021 ErrModifyRuleNotAllow 不允许更改规则 必须修改版本号才允许更改微服务信息。 400022 ErrRuleNotExists 规则不存在 通常出现在查询接口，表明规则不存在，业务根据返回值做恰当后续处理。 400023 Cosumer(s) depends on this micro-service 无法删除该微服务，该微服务被其他微服务依赖 可选择强制删除微服务（url中添加query参数“force=true”）。 400024 ErrPermissionDeny 权限不允许 使用合理的账号进行操作。 400025 ErrEndpointAlreadyExists 端口已存在 建议排查端口是否被其他实例占用。 400026 Micro-service version does not exist 微服务版本不存在 请输入正确的版本号或版本号范围。 400100 Not enough quota 配额不足 对应的资源（如微服务、实例、schema）配额不足，请删除部分资源再创建。 401 401204 No authorization header 认证不通过 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。 401201 Request unauthorized 认证不通过 输入的Authorization不合法. 403 403001 ErrForbidden 操作受限 使用合理的账号进行操作。 500 500011 Registry service is unavailable 后端错误 内部错误请联系运维支持。 500101 ErrUnavailableQuota 没有提供配额 请稍后重试或联系技术支持工程师。 500605 NA 配置中心Etcd连接失败 请稍后重试或联系技术支持工程师。 认证 401 401202 User name or password is wrong 账号名称或密码错误 输入正确的账号名称和密码。 父主题： 附录

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

请求示例 修改环境E CS 资源为id为67835bb3-1235-4cc9-be71-becbb2b4ca0d、名称为ecs-a5a9的弹性云服务器。 { "resources": [ { "id": "67835bb3-1235-4cc9-be71-becbb2b4ca0d", "name": "ecs-a5a9", "type": "ecs" } ] }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of objects 添加资源，请参考表4。 表4 resources 参数 是否必选 参数类型 描述 id 是 String 资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。 name 否 String 资源名称。 type 是 String 资源类型。 eip，弹性公网IP。 elb，弹性负载均衡。 cce，云容器引擎。 ecs，弹性云服务器。 as，弹性伸缩组。 cse，微服务引擎。 dcs，分布式缓存服务。 rds，云数据库。

响应消息 表5 响应参数 参数 参数类型 描述 resources Array of objects 资源，请参考表6。 表6 schemas 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 资源类型。 eip，弹性公网IP。 elb，弹性负载均衡。 cce，云容器引擎。 ecs，弹性云服务器。 as，弹性伸缩组。 cse，微服务引擎。 dcs，分布式缓存服务。 rds，云数据库。

响应参数 状态码： 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 详细定位信息。

响应示例 状态码： 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 微服务引擎专业版，请填租户项目id，长度为1~64，获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版，请填固定值：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 实例的环境信息。