| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <!doctype html> |
| <html> |
| <head> |
| <title>Service Center API</title> |
| <style type="text/css"> |
| body { |
| font-family: Trebuchet MS, sans-serif; |
| font-size: 15px; |
| color: #444; |
| margin-right: 24px; |
| } |
| |
| h1 { |
| font-size: 25px; |
| } |
| h2 { |
| font-size: 20px; |
| } |
| h3 { |
| font-size: 16px; |
| font-weight: bold; |
| } |
| hr { |
| height: 1px; |
| border: 0; |
| color: #ddd; |
| background-color: #ddd; |
| } |
| |
| .app-desc { |
| clear: both; |
| margin-left: 20px; |
| } |
| .param-name { |
| width: 100%; |
| } |
| .license-info { |
| margin-left: 20px; |
| } |
| |
| .license-url { |
| margin-left: 20px; |
| } |
| |
| .model { |
| margin: 0 0 0px 20px; |
| } |
| |
| .method { |
| margin-left: 20px; |
| } |
| |
| .method-notes { |
| margin: 10px 0 20px 0; |
| font-size: 90%; |
| color: #555; |
| } |
| |
| pre { |
| padding: 10px; |
| margin-bottom: 2px; |
| } |
| |
| .http-method { |
| text-transform: uppercase; |
| } |
| |
| pre.get { |
| background-color: #0f6ab4; |
| } |
| |
| pre.post { |
| background-color: #10a54a; |
| } |
| |
| pre.put { |
| background-color: #c5862b; |
| } |
| |
| pre.delete { |
| background-color: #a41e22; |
| } |
| |
| .huge { |
| color: #fff; |
| } |
| |
| pre.example { |
| background-color: #f3f3f3; |
| padding: 10px; |
| border: 1px solid #ddd; |
| } |
| |
| code { |
| white-space: pre; |
| } |
| |
| .nickname { |
| font-weight: bold; |
| } |
| |
| .method-path { |
| font-size: 1.5em; |
| background-color: #0f6ab4; |
| } |
| |
| .up { |
| float:right; |
| } |
| |
| .parameter { |
| width: 500px; |
| } |
| |
| .param { |
| width: 500px; |
| padding: 10px 0 0 20px; |
| font-weight: bold; |
| } |
| |
| .param-desc { |
| width: 700px; |
| padding: 0 0 0 20px; |
| color: #777; |
| } |
| |
| .param-type { |
| font-style: italic; |
| } |
| |
| .param-enum-header { |
| width: 700px; |
| padding: 0 0 0 60px; |
| color: #777; |
| font-weight: bold; |
| } |
| |
| .param-enum { |
| width: 700px; |
| padding: 0 0 0 80px; |
| color: #777; |
| font-style: italic; |
| } |
| |
| .field-label { |
| padding: 0; |
| margin: 0; |
| clear: both; |
| } |
| |
| .field-items { |
| padding: 0 0 15px 0; |
| margin-bottom: 15px; |
| } |
| |
| .return-type { |
| clear: both; |
| padding-bottom: 10px; |
| } |
| |
| .param-header { |
| font-weight: bold; |
| } |
| |
| .method-tags { |
| text-align: right; |
| } |
| |
| .method-tag { |
| background: none repeat scroll 0% 0% #24A600; |
| border-radius: 3px; |
| padding: 2px 10px; |
| margin: 2px; |
| color: #FFF; |
| display: inline-block; |
| text-decoration: none; |
| } |
| |
| </style> |
| </head> |
| <body> |
| <h1>Service Center API</h1> |
| <div class="app-desc">No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)</div> |
| <div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div> |
| <div class="app-desc">Contact Info: <a href="hello@helloreverb.com">hello@helloreverb.com</a></div> |
| <div class="app-desc">Version: 3.0.0</div> |
| <div class="app-desc">BasePath:</div> |
| <div class="license-info">All rights reserved</div> |
| <div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div> |
| <h2>Access</h2> |
| |
| <h2><a name="__Methods">Methods</a></h2> |
| [ Jump to <a href="#__Models">Models</a> ] |
| |
| <h3>Table of Contents </h3> |
| <div class="method-summary"></div> |
| <h4><a href="#Base">Base</a></h4> |
| <ul> |
| <li><a href="#healthGet"><code><span class="http-method">get</span> /health</code></a></li> |
| <li><a href="#versionGet"><code><span class="http-method">get</span> /version</code></a></li> |
| </ul> |
| <h4><a href="#Dependency">Dependency</a></h4> |
| <ul> |
| <li><a href="#createDependenciesForMircServices"><code><span class="http-method">put</span> /registry/v3/dependencies</code></a></li> |
| <li><a href="#getConsumerDependencies"><code><span class="http-method">get</span> /registry/v3/microservices/{consumerId}/providers</code></a></li> |
| <li><a href="#getProviderDependencies"><code><span class="http-method">get</span> /registry/v3/microservices/{providerId}/consumers</code></a></li> |
| </ul> |
| <h4><a href="#Instances">Instances</a></h4> |
| <ul> |
| <li><a href="#find"><code><span class="http-method">get</span> /registry/v3/instances</code></a></li> |
| <li><a href="#getInstances"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/instances</code></a></li> |
| <li><a href="#getOneInstance"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}</code></a></li> |
| <li><a href="#heartbeat"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}/heartbeat</code></a></li> |
| <li><a href="#heartbeatSet"><code><span class="http-method">put</span> /registry/v3/heartbeats</code></a></li> |
| <li><a href="#register"><code><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/instances</code></a></li> |
| <li><a href="#unregister"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}</code></a></li> |
| <li><a href="#updateInstanceProperties"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}/properties</code></a></li> |
| <li><a href="#updateStatus"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}/status</code></a></li> |
| </ul> |
| <h4><a href="#Microservices">Microservices</a></h4> |
| <ul> |
| <li><a href="#addRule"><code><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/rules</code></a></li> |
| <li><a href="#addTags"><code><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/tags</code></a></li> |
| <li><a href="#create"><code><span class="http-method">post</span> /registry/v3/microservices</code></a></li> |
| <li><a href="#delete"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}</code></a></li> |
| <li><a href="#deleteRule"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></a></li> |
| <li><a href="#deleteSchema"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></a></li> |
| <li><a href="#deleteServices"><code><span class="http-method">delete</span> /registry/v3/microservices</code></a></li> |
| <li><a href="#deleteTags"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></a></li> |
| <li><a href="#exist"><code><span class="http-method">get</span> /registry/v3/existence</code></a></li> |
| <li><a href="#getOne"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}</code></a></li> |
| <li><a href="#getRule"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/rules</code></a></li> |
| <li><a href="#getSchemaInfo"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></a></li> |
| <li><a href="#getServices"><code><span class="http-method">get</span> /registry/v3/microservices</code></a></li> |
| <li><a href="#getTags"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/tags</code></a></li> |
| <li><a href="#modifySchema"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></a></li> |
| <li><a href="#modifySchemas"><code><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/schemas</code></a></li> |
| <li><a href="#registryV3MicroservicesServiceIdListwatcherGet"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/listwatcher</code></a></li> |
| <li><a href="#updateProperties"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/properties</code></a></li> |
| <li><a href="#updateRule"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></a></li> |
| <li><a href="#updateTag"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></a></li> |
| <li><a href="#watch"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/watcher</code></a></li> |
| </ul> |
| <h4><a href="#Rule">Rule</a></h4> |
| <ul> |
| <li><a href="#addRule"><code><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/rules</code></a></li> |
| <li><a href="#deleteRule"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></a></li> |
| <li><a href="#getRule"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/rules</code></a></li> |
| <li><a href="#updateRule"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></a></li> |
| </ul> |
| <h4><a href="#Schema">Schema</a></h4> |
| <ul> |
| <li><a href="#deleteSchema"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></a></li> |
| <li><a href="#getSchemaInfo"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></a></li> |
| <li><a href="#modifySchema"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></a></li> |
| <li><a href="#modifySchemas"><code><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/schemas</code></a></li> |
| </ul> |
| <h4><a href="#Schemas">Schemas</a></h4> |
| <ul> |
| <li><a href="#exist"><code><span class="http-method">get</span> /registry/v3/existence</code></a></li> |
| </ul> |
| <h4><a href="#Tag">Tag</a></h4> |
| <ul> |
| <li><a href="#addTags"><code><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/tags</code></a></li> |
| <li><a href="#deleteTags"><code><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></a></li> |
| <li><a href="#getTags"><code><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/tags</code></a></li> |
| <li><a href="#updateTag"><code><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></a></li> |
| </ul> |
| |
| <h1><a name="Base">Base</a></h1> |
| <div class="method"><a name="healthGet"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /health</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">healthGet</span>)</div> |
| <div class="method-notes">查询服务中心集群信息。</div> |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetInstancesResponse">GetInstancesResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instances" : [ { |
| "hostName" : "aeiou", |
| "endpoints" : [ "aeiou" ], |
| "environment" : "aeiou", |
| "instanceId" : "aeiou", |
| "dataCenterInfo" : { |
| "availableZone" : "aeiou", |
| "name" : "aeiou", |
| "region" : "aeiou" |
| }, |
| "healthCheck" : { |
| "mode" : "aeiou", |
| "times" : 1, |
| "port" : 0, |
| "interval" : 6 |
| }, |
| "serviceId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "properties" : { }, |
| "status" : "aeiou", |
| "timestamp" : "aeiou" |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 服务中心实例集群信息列表 |
| <a href="#GetInstancesResponse">GetInstancesResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="versionGet"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /version</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">versionGet</span>)</div> |
| <div class="method-notes">查询服务中心版本信息。</div> |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#Version">Version</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "apiVersion" : "aeiou", |
| "buildTag" : "aeiou", |
| "version" : "aeiou" |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 版本信息结构体 |
| <a href="#Version">Version</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <h1><a name="Dependency">Dependency</a></h1> |
| <div class="method"><a name="createDependenciesForMircServices"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/dependencies</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">createDependenciesForMircServices</span>)</div> |
| <div class="method-notes">创建服务间的依赖关系，consumer的version必须是确定的版本，serviceName不能为*，consumer必须是已存在的服务，provider可以是还未创建的。</div> |
| |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">type <a href="#CreateDependenciesRequest">CreateDependenciesRequest</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 创建服务间的依赖关系的请求体。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| |
| String |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>"aeiou"</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 创建成功 |
| <a href="#String">String</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getConsumerDependencies"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{consumerId}/providers</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getConsumerDependencies</span>)</div> |
| <div class="method-notes">根据consumerId获取该服务的所有providers</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">consumerId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 消费者的服务id。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetConDependenciesResponse">GetConDependenciesResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "dependency" : [ { |
| "Providers" : { |
| "level" : "aeiou", |
| "description" : "aeiou", |
| "serviceName" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "version" : "aeiou", |
| "LBStrategy" : "", |
| "paths" : [ { |
| "Path" : "aeiou", |
| "Property" : { } |
| } ], |
| "appId" : "aeiou", |
| "schemas" : [ "aeiou" ], |
| "serviceId" : "aeiou", |
| "providers" : [ { |
| "stage" : "aeiou", |
| "appId" : "aeiou", |
| "serviceName" : "aeiou", |
| "version" : "aeiou" |
| } ], |
| "properties" : "", |
| "status" : "UP", |
| "timestamp" : "aeiou" |
| } |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetConDependenciesResponse">GetConDependenciesResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getProviderDependencies"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{providerId}/consumers</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getProviderDependencies</span>)</div> |
| <div class="method-notes">根据providerId获取该服务的所有consumers</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">providerId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 提供者的服务id。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetProDependenciesResponse">GetProDependenciesResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "dependency" : [ { |
| "Consumers" : { |
| "level" : "aeiou", |
| "description" : "aeiou", |
| "serviceName" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "version" : "aeiou", |
| "LBStrategy" : "", |
| "paths" : [ { |
| "Path" : "aeiou", |
| "Property" : { } |
| } ], |
| "appId" : "aeiou", |
| "schemas" : [ "aeiou" ], |
| "serviceId" : "aeiou", |
| "providers" : [ { |
| "stage" : "aeiou", |
| "appId" : "aeiou", |
| "serviceName" : "aeiou", |
| "version" : "aeiou" |
| } ], |
| "properties" : "", |
| "status" : "UP", |
| "timestamp" : "aeiou" |
| } |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetProDependenciesResponse">GetProDependenciesResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <h1><a name="Instances">Instances</a></h1> |
| <div class="method"><a name="find"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/instances</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">find</span>)</div> |
| <div class="method-notes">实例注册后可以根据微服务版本规则或字段条件 发现该微服务的实例。</div> |
| |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">appId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 应用app唯一标识。 </div><div class="param">serviceName (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 微服务名称。 </div><div class="param">version (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 版本规则：1.精确版本匹配 2.后续版本匹配 3.最新版本 4.版本范围 </div><div class="param">tags (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — Tag标签过滤，多个时逗号分隔。 </div><div class="param">env (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 实例的environment。 </div><div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetInstancesResponse">GetInstancesResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instances" : [ { |
| "hostName" : "aeiou", |
| "endpoints" : [ "aeiou" ], |
| "environment" : "aeiou", |
| "instanceId" : "aeiou", |
| "dataCenterInfo" : { |
| "availableZone" : "aeiou", |
| "name" : "aeiou", |
| "region" : "aeiou" |
| }, |
| "healthCheck" : { |
| "mode" : "aeiou", |
| "times" : 1, |
| "port" : 0, |
| "interval" : 6 |
| }, |
| "serviceId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "properties" : { }, |
| "status" : "aeiou", |
| "timestamp" : "aeiou" |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetInstancesResponse">GetInstancesResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getInstances"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/instances</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getInstances</span>)</div> |
| <div class="method-notes">实例注册后可以根据 service_id 发现该微服务的所有实例。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">tags (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — Tag标签过滤，多个时逗号分隔。 </div><div class="param">env (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 实例的environment。 </div><div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetInstancesResponse">GetInstancesResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instances" : [ { |
| "hostName" : "aeiou", |
| "endpoints" : [ "aeiou" ], |
| "environment" : "aeiou", |
| "instanceId" : "aeiou", |
| "dataCenterInfo" : { |
| "availableZone" : "aeiou", |
| "name" : "aeiou", |
| "region" : "aeiou" |
| }, |
| "healthCheck" : { |
| "mode" : "aeiou", |
| "times" : 1, |
| "port" : 0, |
| "interval" : 6 |
| }, |
| "serviceId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "properties" : { }, |
| "status" : "aeiou", |
| "timestamp" : "aeiou" |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetInstancesResponse">GetInstancesResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getOneInstance"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getOneInstance</span>)</div> |
| <div class="method-notes">实例注册后可以根据 service_id和serviceId获取该实例的详细信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">instanceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 实例唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">tags (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — Tag标签过滤，多个时逗号分隔。 </div><div class="param">env (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 实例的environment。 </div><div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetOneInstanceResponse">GetOneInstanceResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instance" : { |
| "hostName" : "aeiou", |
| "endpoints" : [ "aeiou" ], |
| "environment" : "aeiou", |
| "instanceId" : "aeiou", |
| "dataCenterInfo" : { |
| "availableZone" : "aeiou", |
| "name" : "aeiou", |
| "region" : "aeiou" |
| }, |
| "healthCheck" : { |
| "mode" : "aeiou", |
| "times" : 1, |
| "port" : 0, |
| "interval" : 6 |
| }, |
| "serviceId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "properties" : { }, |
| "status" : "aeiou", |
| "timestamp" : "aeiou" |
| } |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetOneInstanceResponse">GetOneInstanceResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="heartbeat"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}/heartbeat</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">heartbeat</span>)</div> |
| <div class="method-notes">服务提供端需要向服务中心发送心跳信息，以保证服务中心知道服务实例是否健康。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">instanceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务实例唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 更新成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="heartbeatSet"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/heartbeats</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">heartbeatSet</span>)</div> |
| <div class="method-notes">服务提供端需要向服务中心发送心跳信息，以保证服务中心知道服务实例是否健康。该接口为批量接口</div> |
| |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">Instances <a href="#HeartbeatSetRequest">HeartbeatSetRequest</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 批量上报心跳的实例的标识。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 更新成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#InstancesHbRst">InstancesHbRst</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="register"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/instances</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">register</span>)</div> |
| <div class="method-notes">创建微服务后就可以注册该微服务的实例了。 注册微服务实例时，需提供该微服务实例相关的信息。 |
| instanceID可定制,如果定制了，再次注册就直接全内容覆盖。如果没定制，逻辑如下：系统自动生成id，如果endpoints内容重复，则使用原来的id</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">instance <a href="#CreateInstance">CreateInstance</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 微服务实例请求结构体。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#CreateInstanceResponse">CreateInstanceResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instanceId" : "aeiou" |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 注册成功 |
| <a href="#CreateInstanceResponse">CreateInstanceResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="unregister"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">unregister</span>)</div> |
| <div class="method-notes">实例注册后可以根据 instance_id 进行实例注销。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">instanceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务实例唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 注销成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="updateInstanceProperties"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}/properties</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">updateInstanceProperties</span>)</div> |
| <div class="method-notes">实例注册后可以根据 instance_id 进行添加/更新一个微服务实例扩展信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">instanceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务实例唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">properties <a href="#UpdateProperties">UpdateProperties</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 微服务实例扩展属性请求结构体。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="updateStatus"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/instances/{instanceId}/status</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">updateStatus</span>)</div> |
| <div class="method-notes">实例注册后可以根据 instance_id 进行更新一个微服务实例状态。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">instanceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务实例唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">value (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 实例状态: UP在线,OUTOFSERVICE摘机,STARTING正在启动,DOWN下线,TESTING拨测状态。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <h1><a name="Microservices">Microservices</a></h1> |
| <div class="method"><a name="addRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/rules</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">addRule</span>)</div> |
| <div class="method-notes">为serviceId的服务新增黑白名单，同一服务，attribute和pattern唯一标识一份黑白名单。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">rules <a href="#AddRules">AddRules</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 新增黑白名单。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#AddRuleResponse">AddRuleResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "RuleIds" : [ "aeiou" ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 创建成功 |
| <a href="#AddRuleResponse">AddRuleResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="addTags"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/tags</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">addTags</span>)</div> |
| <div class="method-notes">为serviceId的微服务创建tag。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">tags <a href="#Tags">Tags</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 要创建的tags。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 创建成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="create"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">create</span>)</div> |
| <div class="method-notes">在注册微服务实例前需要创建服务静态信息，之后注册的微服务实例根据service id这个字段与静态信息关联，一个服务对应对多个实例。</div> |
| |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">service <a href="#CreateMicroService">CreateMicroService</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 创建微服务请求结构体。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#CreateMicroServiceResponse">CreateMicroServiceResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "serviceId" : "aeiou" |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 创建成功 |
| <a href="#CreateMicroServiceResponse">CreateMicroServiceResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="delete"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">delete</span>)</div> |
| <div class="method-notes">删除一个微服务定义及其相关信息，同时注销其所有实例信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">force (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 不传即默认为false。 强制删除，则与该服务相关的信息删除，非强制删除： 如果作为该被依赖（作为provider，提供服务,且不是只存在自依赖）或者存在实例，则不能删除,其它均删除。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="deleteRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">deleteRule</span>)</div> |
| <div class="method-notes">为serviceId的服务删除黑白名单。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">rule_id (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — ruleId。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| |
| String |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>"aeiou"</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 删除成功 |
| <a href="#String">String</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="deleteSchema"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">deleteSchema</span>)</div> |
| <div class="method-notes">删除微服务的一个schema信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务契约唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 删除成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="deleteServices"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">deleteServices</span>)</div> |
| <div class="method-notes">批量删除指定的微服务定义及其相关信息，同时注销其所有实例信息。</div> |
| |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">serviceIds <a href="#DelServicesRequest">DelServicesRequest</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 批量删除服务的服务ID列表 </div> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 更新成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#DelServicesResponse">DelServicesResponse</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="deleteTags"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">deleteTags</span>)</div> |
| <div class="method-notes">为serviceId的微服务删除tags</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">key (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 要删除的tag的key值，多个key的话，以，隔开。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 删除成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="exist"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/existence</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">exist</span>)</div> |
| <div class="method-notes">可通过指定条件，查询微服务serviceId或schema的唯一标识信息。</div> |
| |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">type (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型 microservice微服务 schema微服务访问契约。 </div><div class="param">appId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 microservice时 需传入应用app唯一标识。 </div><div class="param">serviceName (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 microservice时 需传入微服务名称。 </div><div class="param">version (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 microservice时 需传入微服务版本。 </div><div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 schema时 需传入微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 schema时 需传入schema唯一标识。 </div><div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetResourceResponse">GetResourceResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "schemaId" : "aeiou", |
| "serviceId" : "aeiou" |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetResourceResponse">GetResourceResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getOne"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getOne</span>)</div> |
| <div class="method-notes">根据serviceId查询微服务定义信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#CreateMicroService">CreateMicroService</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instances" : [ { |
| "hostName" : "aeiou", |
| "endpoints" : [ "aeiou" ], |
| "environment" : "aeiou", |
| "instanceId" : "aeiou", |
| "dataCenterInfo" : { |
| "availableZone" : "aeiou", |
| "name" : "aeiou", |
| "region" : "aeiou" |
| }, |
| "healthCheck" : { |
| "mode" : "aeiou", |
| "times" : 1, |
| "port" : 0, |
| "interval" : 6 |
| }, |
| "properties" : "", |
| "status" : "aeiou" |
| } ], |
| "service" : { |
| "level" : "aeiou", |
| "description" : "aeiou", |
| "serviceName" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "version" : "aeiou", |
| "LBStrategy" : "", |
| "paths" : [ { |
| "Path" : "aeiou", |
| "Property" : { } |
| } ], |
| "appId" : "aeiou", |
| "schemas" : [ "aeiou" ], |
| "serviceId" : "aeiou", |
| "providers" : [ { |
| "stage" : "aeiou", |
| "appId" : "aeiou", |
| "serviceName" : "aeiou", |
| "version" : "aeiou" |
| } ], |
| "properties" : "", |
| "status" : "UP", |
| "timestamp" : "aeiou" |
| }, |
| "rules" : [ { |
| "ruleType" : "aeiou", |
| "pattern" : "aeiou", |
| "description" : "aeiou", |
| "attribute" : "aeiou", |
| "ruleId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "timestamp" : "aeiou" |
| } ], |
| "tags" : { |
| "tags" : "" |
| } |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 微服务结构体 |
| <a href="#CreateMicroService">CreateMicroService</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/rules</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getRule</span>)</div> |
| <div class="method-notes">获取serviceId的服务的黑白名单信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#Rules">Rules</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "rules" : [ { |
| "ruleType" : "aeiou", |
| "pattern" : "aeiou", |
| "description" : "aeiou", |
| "attribute" : "aeiou", |
| "ruleId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "timestamp" : "aeiou" |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#Rules">Rules</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getSchemaInfo"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getSchemaInfo</span>)</div> |
| <div class="method-notes">根据serviceId和schemaId查询微服务的schema信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务契约唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#CreateSchema">CreateSchema</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "schema" : "aeiou" |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#CreateSchema">CreateSchema</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getServices"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getServices</span>)</div> |
| <div class="method-notes">根据条件组合，查询满足所有条件的微服务定义信息。</div> |
| |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetMicroServicesResponse">GetMicroServicesResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "services" : [ { |
| "level" : "aeiou", |
| "description" : "aeiou", |
| "serviceName" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "version" : "aeiou", |
| "LBStrategy" : "", |
| "paths" : [ { |
| "Path" : "aeiou", |
| "Property" : { } |
| } ], |
| "appId" : "aeiou", |
| "schemas" : [ "aeiou" ], |
| "serviceId" : "aeiou", |
| "providers" : [ { |
| "stage" : "aeiou", |
| "appId" : "aeiou", |
| "serviceName" : "aeiou", |
| "version" : "aeiou" |
| } ], |
| "properties" : "", |
| "status" : "UP", |
| "timestamp" : "aeiou" |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetMicroServicesResponse">GetMicroServicesResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getTags"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/tags</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getTags</span>)</div> |
| <div class="method-notes">获取serviceId的微服务的tag</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#Tags">Tags</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "tags" : { } |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#Tags">Tags</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="modifySchema"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">modifySchema</span>)</div> |
| <div class="method-notes">根据schemaId更新微服务的访问契约内容。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务契约唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">schema <a href="#CreateSchema">CreateSchema</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 微服务契约内容。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="modifySchemas"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/schemas</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">modifySchemas</span>)</div> |
| <div class="method-notes">批量上传schemas。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">type <a href="#ModifySchemasRequest">ModifySchemasRequest</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 批量上传schemas信息。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 創建成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="registryV3MicroservicesServiceIdListwatcherGet"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/listwatcher</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">registryV3MicroservicesServiceIdListwatcherGet</span>)</div> |
| <div class="method-notes">watch成功后返回完整的微服务提供者的实例信息，且服务在心跳消失，注册，注销，状态更新时，将这些变化主动推送到客户端。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务消费者的微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#WatchInstanceResponse">WatchInstanceResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instance" : { |
| "hostName" : "aeiou", |
| "endpoints" : [ "aeiou" ], |
| "environment" : "aeiou", |
| "instanceId" : "aeiou", |
| "dataCenterInfo" : { |
| "availableZone" : "aeiou", |
| "name" : "aeiou", |
| "region" : "aeiou" |
| }, |
| "healthCheck" : { |
| "mode" : "aeiou", |
| "times" : 1, |
| "port" : 0, |
| "interval" : 6 |
| }, |
| "serviceId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "properties" : { }, |
| "status" : "aeiou", |
| "timestamp" : "aeiou" |
| }, |
| "action" : "aeiou", |
| "key" : { |
| "appId" : "aeiou", |
| "serviceName" : "aeiou", |
| "version" : "aeiou" |
| } |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 推送给watcher实例变化信息 |
| <a href="#WatchInstanceResponse">WatchInstanceResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="updateProperties"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/properties</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">updateProperties</span>)</div> |
| <div class="method-notes">创建微服务静态信息后可对服务部分字段进行更新，每次更新都需要传入完整的服务静态信息json，也就是说，即便不更新部分的字段也要作为json的属性传过去。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">properties <a href="#UpdateProperties">UpdateProperties</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 微服务扩展属性请求结构体。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="updateRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">updateRule</span>)</div> |
| <div class="method-notes">为serviceId的服务更新黑白名单。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">rule_id (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — ruleId。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">rule <a href="#AddOrUpdateRule">AddOrUpdateRule</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 要更新的rule </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| |
| String |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>"aeiou"</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#String">String</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="updateTag"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">updateTag</span>)</div> |
| <div class="method-notes">为serviceId的微服务更新key对应的value值</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">key (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 要更新的tag的key值。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">value (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 要更新的tag的value值。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 更新成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="watch"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/watcher</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">watch</span>)</div> |
| <div class="method-notes">当服务在心跳消失，注册，注销，状态更新时， 将这些变化主动推送到客户端。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务消费者的微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#WatchInstanceResponse">WatchInstanceResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "instance" : { |
| "hostName" : "aeiou", |
| "endpoints" : [ "aeiou" ], |
| "environment" : "aeiou", |
| "instanceId" : "aeiou", |
| "dataCenterInfo" : { |
| "availableZone" : "aeiou", |
| "name" : "aeiou", |
| "region" : "aeiou" |
| }, |
| "healthCheck" : { |
| "mode" : "aeiou", |
| "times" : 1, |
| "port" : 0, |
| "interval" : 6 |
| }, |
| "serviceId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "properties" : { }, |
| "status" : "aeiou", |
| "timestamp" : "aeiou" |
| }, |
| "action" : "aeiou", |
| "key" : { |
| "appId" : "aeiou", |
| "serviceName" : "aeiou", |
| "version" : "aeiou" |
| } |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 实例变化时，成功推送给watcher的信息 |
| <a href="#WatchInstanceResponse">WatchInstanceResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <h1><a name="Rule">Rule</a></h1> |
| <div class="method"><a name="addRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/rules</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">addRule</span>)</div> |
| <div class="method-notes">为serviceId的服务新增黑白名单，同一服务，attribute和pattern唯一标识一份黑白名单。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">rules <a href="#AddRules">AddRules</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 新增黑白名单。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#AddRuleResponse">AddRuleResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "RuleIds" : [ "aeiou" ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 创建成功 |
| <a href="#AddRuleResponse">AddRuleResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="deleteRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">deleteRule</span>)</div> |
| <div class="method-notes">为serviceId的服务删除黑白名单。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">rule_id (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — ruleId。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| |
| String |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>"aeiou"</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 删除成功 |
| <a href="#String">String</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/rules</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getRule</span>)</div> |
| <div class="method-notes">获取serviceId的服务的黑白名单信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#Rules">Rules</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "rules" : [ { |
| "ruleType" : "aeiou", |
| "pattern" : "aeiou", |
| "description" : "aeiou", |
| "attribute" : "aeiou", |
| "ruleId" : "aeiou", |
| "modTimestamp" : "aeiou", |
| "timestamp" : "aeiou" |
| } ] |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#Rules">Rules</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="updateRule"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/rules/{rule_id}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">updateRule</span>)</div> |
| <div class="method-notes">为serviceId的服务更新黑白名单。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">rule_id (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — ruleId。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">rule <a href="#AddOrUpdateRule">AddOrUpdateRule</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 要更新的rule </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| |
| String |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>"aeiou"</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#String">String</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <h1><a name="Schema">Schema</a></h1> |
| <div class="method"><a name="deleteSchema"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">deleteSchema</span>)</div> |
| <div class="method-notes">删除微服务的一个schema信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务契约唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 删除成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getSchemaInfo"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getSchemaInfo</span>)</div> |
| <div class="method-notes">根据serviceId和schemaId查询微服务的schema信息。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务契约唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#CreateSchema">CreateSchema</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "schema" : "aeiou" |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#CreateSchema">CreateSchema</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="modifySchema"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/schemas/{schemaId}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">modifySchema</span>)</div> |
| <div class="method-notes">根据schemaId更新微服务的访问契约内容。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务契约唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">schema <a href="#CreateSchema">CreateSchema</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 微服务契约内容。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 修改成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="modifySchemas"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/schemas</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">modifySchemas</span>)</div> |
| <div class="method-notes">批量上传schemas。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">type <a href="#ModifySchemasRequest">ModifySchemasRequest</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 批量上传schemas信息。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 創建成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <h1><a name="Schemas">Schemas</a></h1> |
| <div class="method"><a name="exist"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/existence</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">exist</span>)</div> |
| <div class="method-notes">可通过指定条件，查询微服务serviceId或schema的唯一标识信息。</div> |
| |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">type (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型 microservice微服务 schema微服务访问契约。 </div><div class="param">appId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 microservice时 需传入应用app唯一标识。 </div><div class="param">serviceName (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 microservice时 需传入微服务名称。 </div><div class="param">version (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 microservice时 需传入微服务版本。 </div><div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 schema时 需传入微服务唯一标识。 </div><div class="param">schemaId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 资源类型为 schema时 需传入schema唯一标识。 </div><div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#GetResourceResponse">GetResourceResponse</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "schemaId" : "aeiou", |
| "serviceId" : "aeiou" |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#GetResourceResponse">GetResourceResponse</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <h1><a name="Tag">Tag</a></h1> |
| <div class="method"><a name="addTags"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="post"><code class="huge"><span class="http-method">post</span> /registry/v3/microservices/{serviceId}/tags</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">addTags</span>)</div> |
| <div class="method-notes">为serviceId的微服务创建tag。</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Request body</h3> |
| <div class="field-items"> |
| <div class="param">tags <a href="#Tags">Tags</a> (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Body Parameter</span> — 要创建的tags。 </div> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 创建成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="deleteTags"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="delete"><code class="huge"><span class="http-method">delete</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">deleteTags</span>)</div> |
| <div class="method-notes">为serviceId的微服务删除tags</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">key (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 要删除的tag的key值，多个key的话，以，隔开。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 删除成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="getTags"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /registry/v3/microservices/{serviceId}/tags</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">getTags</span>)</div> |
| <div class="method-notes">获取serviceId的微服务的tag</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">noCache (optional)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 是否强一致性，1 是、0 否。 default: 0 </div> |
| </div> <!-- field-items --> |
| |
| |
| <h3 class="field-label">Return type</h3> |
| <div class="return-type"> |
| <a href="#Tags">Tags</a> |
| |
| </div> |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| <h3 class="field-label">Example data</h3> |
| <div class="example-data-content-type">Content-Type: application/json</div> |
| <pre class="example"><code>{ |
| "tags" : { } |
| }</code></pre> |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 查询成功 |
| <a href="#Tags">Tags</a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| <div class="method"><a name="updateTag"/> |
| <div class="method-path"> |
| <a class="up" href="#__Methods">Up</a> |
| <pre class="put"><code class="huge"><span class="http-method">put</span> /registry/v3/microservices/{serviceId}/tags/{key}</code></pre></div> |
| <div class="method-summary"> (<span class="nickname">updateTag</span>)</div> |
| <div class="method-notes">为serviceId的微服务更新key对应的value值</div> |
| |
| <h3 class="field-label">Path parameters</h3> |
| <div class="field-items"> |
| <div class="param">serviceId (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 微服务唯一标识。 </div><div class="param">key (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Path Parameter</span> — 要更新的tag的key值。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <h3 class="field-label">Request headers</h3> |
| <div class="field-items"> |
| |
| </div> <!-- field-items --> |
| |
| <h3 class="field-label">Query parameters</h3> |
| <div class="field-items"> |
| <div class="param">value (required)</div> |
| |
| <div class="param-desc"><span class="param-type">Query Parameter</span> — 要更新的tag的value值。 </div> |
| </div> <!-- field-items --> |
| |
| |
| |
| <!--Todo: process Response Object and its headers, schema, examples --> |
| |
| |
| <h3 class="field-label">Produces</h3> |
| This API call produces the following media types according to the <span class="header">Accept</span> request header; |
| the media type will be conveyed by the <span class="heaader">Content-Type</span> response header. |
| <ul> |
| <li><code>application/json</code></li> |
| </ul> |
| |
| <h3 class="field-label">Responses</h3> |
| <h4 class="field-label">200</h4> |
| 更新成功 |
| <a href="#"></a> |
| <h4 class="field-label">400</h4> |
| 错误的请求 |
| <a href="#String">String</a> |
| <h4 class="field-label">500</h4> |
| 内部错误 |
| <a href="#String">String</a> |
| </div> <!-- method --> |
| <hr/> |
| |
| <h2><a name="__Models">Models</a></h2> |
| [ Jump to <a href="#__Methods">Methods</a> ] |
| |
| <h3>Table of Contents</h3> |
| <ol> |
| <li><a href="#AddOrUpdateRule"><code>AddOrUpdateRule</code> - </a></li> |
| <li><a href="#AddRuleResponse"><code>AddRuleResponse</code> - </a></li> |
| <li><a href="#AddRules"><code>AddRules</code> - </a></li> |
| <li><a href="#ConDependency"><code>ConDependency</code> - </a></li> |
| <li><a href="#CreateDependenciesRequest"><code>CreateDependenciesRequest</code> - </a></li> |
| <li><a href="#CreateInstance"><code>CreateInstance</code> - </a></li> |
| <li><a href="#CreateInstanceResponse"><code>CreateInstanceResponse</code> - </a></li> |
| <li><a href="#CreateMicroService"><code>CreateMicroService</code> - </a></li> |
| <li><a href="#CreateMicroServiceResponse"><code>CreateMicroServiceResponse</code> - </a></li> |
| <li><a href="#CreateSchema"><code>CreateSchema</code> - </a></li> |
| <li><a href="#DataCenterInfo"><code>DataCenterInfo</code> - </a></li> |
| <li><a href="#DelServicesRequest"><code>DelServicesRequest</code> - </a></li> |
| <li><a href="#DelServicesResponse"><code>DelServicesResponse</code> - </a></li> |
| <li><a href="#DelServicesRspInfo"><code>DelServicesRspInfo</code> - </a></li> |
| <li><a href="#DependencyMicroService"><code>DependencyMicroService</code> - </a></li> |
| <li><a href="#GetConDependenciesResponse"><code>GetConDependenciesResponse</code> - </a></li> |
| <li><a href="#GetInstancesResponse"><code>GetInstancesResponse</code> - </a></li> |
| <li><a href="#GetMicroServicesResponse"><code>GetMicroServicesResponse</code> - </a></li> |
| <li><a href="#GetOneInstanceResponse"><code>GetOneInstanceResponse</code> - </a></li> |
| <li><a href="#GetProDependenciesResponse"><code>GetProDependenciesResponse</code> - </a></li> |
| <li><a href="#GetResourceResponse"><code>GetResourceResponse</code> - </a></li> |
| <li><a href="#HealthCheck"><code>HealthCheck</code> - </a></li> |
| <li><a href="#HeartbeatSetElement"><code>HeartbeatSetElement</code> - </a></li> |
| <li><a href="#HeartbeatSetRequest"><code>HeartbeatSetRequest</code> - </a></li> |
| <li><a href="#InstanceHbRst"><code>InstanceHbRst</code> - </a></li> |
| <li><a href="#InstancesHbRst"><code>InstancesHbRst</code> - </a></li> |
| <li><a href="#MicroService"><code>MicroService</code> - </a></li> |
| <li><a href="#MicroServiceDependency"><code>MicroServiceDependency</code> - </a></li> |
| <li><a href="#MicroServiceInstance"><code>MicroServiceInstance</code> - </a></li> |
| <li><a href="#ModifySchemasRequest"><code>ModifySchemasRequest</code> - </a></li> |
| <li><a href="#ProDependency"><code>ProDependency</code> - </a></li> |
| <li><a href="#Properties"><code>Properties</code> - </a></li> |
| <li><a href="#RegistMicroserviceInstance"><code>RegistMicroserviceInstance</code> - </a></li> |
| <li><a href="#Rule"><code>Rule</code> - </a></li> |
| <li><a href="#Rules"><code>Rules</code> - </a></li> |
| <li><a href="#Schema"><code>Schema</code> - </a></li> |
| <li><a href="#ServicePath"><code>ServicePath</code> - </a></li> |
| <li><a href="#Tags"><code>Tags</code> - </a></li> |
| <li><a href="#UpdateProperties"><code>UpdateProperties</code> - </a></li> |
| <li><a href="#Version"><code>Version</code> - </a></li> |
| <li><a href="#WatchInstanceResponse"><code>WatchInstanceResponse</code> - </a></li> |
| <li><a href="#WatchMicroServiceKey"><code>WatchMicroServiceKey</code> - </a></li> |
| </ol> |
| |
| <div class="model"> |
| <h3><a name="AddOrUpdateRule"><code>AddOrUpdateRule</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">ruleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> rule类型，WHITE或者BLACK </div> |
| <div class="param">attribute (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 如果是tag_xxx开头，则按Tag过滤attribute属性，否则，则按"ServiceId", "AppId", "ServiceName", "Version", "Description", "Level", "Status"过滤 </div> |
| <div class="param">pattern (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 匹配规则，正则表达式，长度1到64 </div> |
| <div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> rule描述 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="AddRuleResponse"><code>AddRuleResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">RuleIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> 生成的ruleId集合 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="AddRules"><code>AddRules</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">rules (optional)</div><div class="param-desc"><span class="param-type"><a href="#AddOrUpdateRule">array[AddOrUpdateRule]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="ConDependency"><code>ConDependency</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">Providers (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroService">MicroService</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="CreateDependenciesRequest"><code>CreateDependenciesRequest</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">dependencies (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroServiceDependency">array[MicroServiceDependency]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="CreateInstance"><code>CreateInstance</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">instance (optional)</div><div class="param-desc"><span class="param-type"><a href="#RegistMicroserviceInstance">RegistMicroserviceInstance</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="CreateInstanceResponse"><code>CreateInstanceResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">instanceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="CreateMicroService"><code>CreateMicroService</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">service (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroService">MicroService</a></span> </div> |
| <div class="param">rules (optional)</div><div class="param-desc"><span class="param-type"><a href="#Rule">array[Rule]</a></span> </div> |
| <div class="param">instances (optional)</div><div class="param-desc"><span class="param-type"><a href="#RegistMicroserviceInstance">array[RegistMicroserviceInstance]</a></span> </div> |
| <div class="param">tags (optional)</div><div class="param-desc"><span class="param-type"><a href="#Tags">Tags</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="CreateMicroServiceResponse"><code>CreateMicroServiceResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">serviceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="CreateSchema"><code>CreateSchema</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">schema (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="DataCenterInfo"><code>DataCenterInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 区域名字 </div> |
| <div class="param">region </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 区域 </div> |
| <div class="param">availableZone </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 可获取区 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="DelServicesRequest"><code>DelServicesRequest</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">serviceIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div> |
| <div class="param">force (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 不传即默认为false。 强制删除，则与该服务相关的信息删除，非强制删除： 如果作为该被依赖（作为provider，提供服务,且不是只存在自依赖）或者存在实例，则不能删除,其它均删除。 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="DelServicesResponse"><code>DelServicesResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">services (optional)</div><div class="param-desc"><span class="param-type"><a href="#DelServicesRspInfo">array[DelServicesRspInfo]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="DelServicesRspInfo"><code>DelServicesRspInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">serviceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务id </div> |
| <div class="param">errMessage (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 错误信息，成功为空，不成功，则为错误，在部分成功的场景使用 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="DependencyMicroService"><code>DependencyMicroService</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">appId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 应用app唯一标识。 </div> |
| <div class="param">serviceName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务名称，作为provider支持为*，表示依赖同一租户下的所有服务,当服务名称为<em>的时候，appId和version可以省略，consumer不支持</em>。 </div> |
| <div class="param">version </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务版本，作为provider支持+，如1.0.1+[表示1.0.1以上的版本(包括1.0.1)]、固定版本和latest(当前最新版本)，作为consumer只能为固定版本。 </div> |
| <div class="param">stage (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 服务的stage。 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="GetConDependenciesResponse"><code>GetConDependenciesResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">dependency (optional)</div><div class="param-desc"><span class="param-type"><a href="#ConDependency">array[ConDependency]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="GetInstancesResponse"><code>GetInstancesResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">instances (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroServiceInstance">array[MicroServiceInstance]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="GetMicroServicesResponse"><code>GetMicroServicesResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">services (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroService">array[MicroService]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="GetOneInstanceResponse"><code>GetOneInstanceResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">instance (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroServiceInstance">MicroServiceInstance</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="GetProDependenciesResponse"><code>GetProDependenciesResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">dependency (optional)</div><div class="param-desc"><span class="param-type"><a href="#ProDependency">array[ProDependency]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="GetResourceResponse"><code>GetResourceResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">serviceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">schemaId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="HealthCheck"><code>HealthCheck</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">mode </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> check模式 push/pull </div> |
| <div class="param">port (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> 端口 </div> |
| <div class="param">interval </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> check interval (second) </div> |
| <div class="param">times </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> retry times </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="HeartbeatSetElement"><code>HeartbeatSetElement</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">serviceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务id </div> |
| <div class="param">instanceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务实例id </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="HeartbeatSetRequest"><code>HeartbeatSetRequest</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">Instances (optional)</div><div class="param-desc"><span class="param-type"><a href="#HeartbeatSetElement">array[HeartbeatSetElement]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="InstanceHbRst"><code>InstanceHbRst</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">serviceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务id </div> |
| <div class="param">instanceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务实例id </div> |
| <div class="param">errMessage (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 错误信息，成功为空，不成功，则为错误，在部分成功的场景使用 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="InstancesHbRst"><code>InstancesHbRst</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">instances (optional)</div><div class="param-desc"><span class="param-type"><a href="#InstanceHbRst">array[InstanceHbRst]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="MicroService"><code>MicroService</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">serviceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">appId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 应用App唯一标识 </div> |
| <div class="param">serviceName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务名称，同一个App要保证唯一 </div> |
| <div class="param">version </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务版本号 </div> |
| <div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务描述信息 </div> |
| <div class="param">level (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务层级，FRONT/MIDDLE/BACK </div> |
| <div class="param">schemas (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> 微服务访问契约内容的外键ID </div> |
| <div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务状态，UP表示上线 DOWN表示下线 </div> |
| <div class="param-enum-header">Enum:</div> |
| <div class="param-enum">UP</div><div class="param-enum">DOWN</div> |
| <div class="param">timestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> post 或者 put 不带该参数，timestamp是内部生成的，只有get 接口才返回该值 </div> |
| <div class="param">modTimestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 更新时间 </div> |
| <div class="param">paths (optional)</div><div class="param-desc"><span class="param-type"><a href="#ServicePath">array[ServicePath]</a></span> 服务路由 </div> |
| <div class="param">providers (optional)</div><div class="param-desc"><span class="param-type"><a href="#DependencyMicroService">array[DependencyMicroService]</a></span> </div> |
| <div class="param">properties (optional)</div><div class="param-desc"><span class="param-type"><a href="#Properties">Properties</a></span> </div> |
| <div class="param">LBStrategy (optional)</div><div class="param-desc"><span class="param-type"><a href="#Properties">Properties</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="MicroServiceDependency"><code>MicroServiceDependency</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">consumer (optional)</div><div class="param-desc"><span class="param-type"><a href="#DependencyMicroService">DependencyMicroService</a></span> </div> |
| <div class="param">providers (optional)</div><div class="param-desc"><span class="param-type"><a href="#DependencyMicroService">array[DependencyMicroService]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="MicroServiceInstance"><code>MicroServiceInstance</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">instanceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 实例id,唯一标识。创建实例，instanceId由service-center产生 </div> |
| <div class="param">serviceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 微服务唯一标识，创建实例时，以url里面的为准，不用这里的serviceId。 </div> |
| <div class="param">hostName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">endpoints (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div> |
| <div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 实例状态，UP|DOWN|STARTING|OUTOFSERVICE|TESTING </div> |
| <div class="param">properties (optional)</div><div class="param-desc"><span class="param-type"><a href="#Properties">Properties</a></span> </div> |
| <div class="param">healthCheck (optional)</div><div class="param-desc"><span class="param-type"><a href="#HealthCheck">HealthCheck</a></span> </div> |
| <div class="param">environment </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> development|testing|acceptance|production </div> |
| <div class="param">dataCenterInfo (optional)</div><div class="param-desc"><span class="param-type"><a href="#DataCenterInfo">DataCenterInfo</a></span> </div> |
| <div class="param">timestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 实例创建时间戳，自动生成 </div> |
| <div class="param">modTimestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 更新时间 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="ModifySchemasRequest"><code>ModifySchemasRequest</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">schemas (optional)</div><div class="param-desc"><span class="param-type"><a href="#Schema">array[Schema]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="ProDependency"><code>ProDependency</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">Consumers (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroService">MicroService</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="Properties"><code>Properties</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'>扩展属性</div> |
| <div class="field-items"> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="RegistMicroserviceInstance"><code>RegistMicroserviceInstance</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">instanceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 实例ID,不填写会自动填充 </div> |
| <div class="param">hostName </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 机器的hostname </div> |
| <div class="param">endpoints (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div> |
| <div class="param">status </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 实例状态，UP|DOWN|STARTING|OUTOFSERVICE|TESTING </div> |
| <div class="param">properties (optional)</div><div class="param-desc"><span class="param-type"><a href="#Properties">Properties</a></span> </div> |
| <div class="param">healthCheck (optional)</div><div class="param-desc"><span class="param-type"><a href="#HealthCheck">HealthCheck</a></span> </div> |
| <div class="param">environment </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> development|testing|acceptance|production </div> |
| <div class="param">dataCenterInfo (optional)</div><div class="param-desc"><span class="param-type"><a href="#DataCenterInfo">DataCenterInfo</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="Rule"><code>Rule</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">ruleId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 自定义ruleId </div> |
| <div class="param">ruleType (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> rule类型，WHITE或者BLACK </div> |
| <div class="param">attribute (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 如果是tag_xxx开头，则按Tag过滤attribute属性，否则，则按"ServiceId", "AppId", "ServiceName", "Version", "Description", "Level", "Status"过滤 </div> |
| <div class="param">pattern (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 匹配规则，正则表达式，长度1到64 </div> |
| <div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> rule描述 </div> |
| <div class="param">timestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 只有获取rule时返回使用，创建rule的时间 </div> |
| <div class="param">modTimestamp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 更新时间 </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="Rules"><code>Rules</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">rules (optional)</div><div class="param-desc"><span class="param-type"><a href="#Rule">array[Rule]</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="Schema"><code>Schema</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">schemaId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">schema (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">summary (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="ServicePath"><code>ServicePath</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">Path (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 路由地址 </div> |
| <div class="param">Property (optional)</div><div class="param-desc"><span class="param-type"><a href="#Properties">Properties</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="Tags"><code>Tags</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">tags (optional)</div><div class="param-desc"><span class="param-type"><a href="#Properties">Properties</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="UpdateProperties"><code>UpdateProperties</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">properties (optional)</div><div class="param-desc"><span class="param-type"><a href="#Properties">Properties</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="Version"><code>Version</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">version (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">apiVersion (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">buildTag (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="WatchInstanceResponse"><code>WatchInstanceResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">action (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> 分别有CREATE UPDATE DELETE三种事件 </div> |
| <div class="param">key (optional)</div><div class="param-desc"><span class="param-type"><a href="#WatchMicroServiceKey">WatchMicroServiceKey</a></span> </div> |
| <div class="param">instance (optional)</div><div class="param-desc"><span class="param-type"><a href="#MicroServiceInstance">MicroServiceInstance</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| <div class="model"> |
| <h3><a name="WatchMicroServiceKey"><code>WatchMicroServiceKey</code> - </a> <a class="up" href="#__Models">Up</a></h3> |
| <div class='model-description'></div> |
| <div class="field-items"> |
| <div class="param">appId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">serviceName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| <div class="param">version (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div> |
| </div> <!-- field-items --> |
| </div> |
| </body> |
| </html> |
