You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by zh...@apache.org on 2018/08/16 12:14:33 UTC
[incubator-servicecomb-docs] 01/03: add safa user guide of cn and
en version
This is an automated email from the ASF dual-hosted git repository.
zhengyangyong pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-docs.git
commit 53a2af3dee65e279686ee570d0e053bfb9274ee7
Author: DeanLee <li...@huawei.com>
AuthorDate: Thu Aug 9 21:29:00 2018 +0800
add safa user guide of cn and en version
update saga content such as dir nav and default page
add service-center-reference docs update SUMMARY.md
fix issue
---
saga-reference/LANGS.md | 2 +
saga-reference/en_US/README.md | 133 +
saga-reference/en_US/SUMMARY.md | 9 +
saga-reference/en_US/api/api.md | 168 +
saga-reference/en_US/book.json | 5 +
saga-reference/en_US/design.md | 46 +
saga-reference/en_US/enable_ssl.md | 87 +
.../how_to_use_mysql_as_alpha_backend_database.md | 43 +
saga-reference/en_US/old_saga.md | 53 +
.../en_US/static_files/exception_scenario.png | Bin 0 -> 49821 bytes
.../en_US/static_files/exception_scenario_TCC.png | Bin 0 -> 151451 bytes
.../static_files/inter-service_communication.png | Bin 0 -> 18719 bytes
.../en_US/static_files/omega_internal.png | Bin 0 -> 22521 bytes
saga-reference/en_US/static_files/pack.png | Bin 0 -> 10413 bytes
saga-reference/en_US/static_files/saga.png | Bin 0 -> 45493 bytes
.../en_US/static_files/successful_scenario.png | Bin 0 -> 47326 bytes
.../en_US/static_files/successful_scenario_TCC.png | Bin 0 -> 163718 bytes
.../en_US/static_files/timeout_scenario.png | Bin 0 -> 44045 bytes
saga-reference/en_US/user_guide.md | 136 +
saga-reference/zh_CN/README.md | 131 +
saga-reference/zh_CN/SUMMARY.md | 9 +
saga-reference/zh_CN/api/api.md | 170 +
saga-reference/zh_CN/book.json | 5 +
saga-reference/zh_CN/design_zh.md | 47 +
saga-reference/zh_CN/enable_ssl.md | 84 +
...ow_to_use_mysql_as_alpha_backend_database_zh.md | 42 +
.../zh_CN/static_files/exception_scenario.png | Bin 0 -> 49821 bytes
.../zh_CN/static_files/exception_scenario_TCC.png | Bin 0 -> 151451 bytes
.../static_files/inter-service_communication.png | Bin 0 -> 18719 bytes
.../zh_CN/static_files/omega_internal.png | Bin 0 -> 22521 bytes
saga-reference/zh_CN/static_files/pack.png | Bin 0 -> 10413 bytes
saga-reference/zh_CN/static_files/saga.png | Bin 0 -> 45493 bytes
.../zh_CN/static_files/successful_scenario.png | Bin 0 -> 47326 bytes
.../zh_CN/static_files/successful_scenario_TCC.png | Bin 0 -> 163718 bytes
.../zh_CN/static_files/timeout_scenario.png | Bin 0 -> 44045 bytes
saga-reference/zh_CN/user_guide_zh.md | 136 +
service-center-reference/LANGS.md | 2 +
service-center-reference/book.json | 5 +
service-center-reference/en_US/README.md | 33 +
service-center-reference/en_US/SUMMARY.md | 83 +
service-center-reference/en_US/api-docs.html | 3703 ++++++++++++++++++++
service-center-reference/en_US/contribution.md | 50 +
service-center-reference/en_US/design.md | 26 +
service-center-reference/en_US/dev-guide.md | 97 +
.../en_US/integration-grafana.md | 9 +
service-center-reference/en_US/pr-raising-guide.md | 24 +
service-center-reference/en_US/release/Readme.md | 42 +
.../release/rat-report/Rat-Report-2018-02-23.md | 266 ++
.../release/rat-report/Rat-Report-2018-03-08.md | 280 ++
.../release/rat-report/Rat-Report-2018-06-01.md | 349 ++
.../en_US/release/releaseNotes-1.0.0-m1.md | 30 +
.../en_US/release/releaseNotes-1.0.0-m2.md | 39 +
.../en_US/release/releaseNotes-1.0.0.md | 21 +
service-center-reference/en_US/sc-cluster.md | 109 +
service-center-reference/en_US/security-tls.md | 18 +
.../static_files/Service-Center-UI-Preview.gif | Bin 0 -> 616202 bytes
.../en_US/static_files/communication.PNG | Bin 0 -> 26597 bytes
.../en_US/static_files/integration-grafana.PNG | Bin 0 -> 74642 bytes
.../en_US/static_files/onStartup.PNG | Bin 0 -> 28938 bytes
.../en_US/static_files/tracing-file.PNG | Bin 0 -> 32339 bytes
.../en_US/static_files/tracing-server.PNG | Bin 0 -> 32308 bytes
service-center-reference/zh_CN/README.md | 33 +
service-center-reference/zh_CN/SUMMARY.md | 33 +
service-center-reference/zh_CN/api-docs.html | 3703 ++++++++++++++++++++
service-center-reference/zh_CN/contribution.md | 50 +
service-center-reference/zh_CN/design.md | 29 +
service-center-reference/zh_CN/dev-guide.md | 94 +
.../zh_CN/integration-grafana.md | 9 +
service-center-reference/zh_CN/pr-raising-guide.md | 24 +
service-center-reference/zh_CN/release/Readme.md | 42 +
.../release/rat-report/Rat-Report-2018-02-23.md | 266 ++
.../release/rat-report/Rat-Report-2018-03-08.md | 280 ++
.../release/rat-report/Rat-Report-2018-06-01.md | 349 ++
.../zh_CN/release/releaseNotes-1.0.0-m1.md | 30 +
.../zh_CN/release/releaseNotes-1.0.0-m2.md | 39 +
.../zh_CN/release/releaseNotes-1.0.0.md | 21 +
service-center-reference/zh_CN/sc-cluster.md | 109 +
service-center-reference/zh_CN/security-tls.md | 18 +
.../static_files/Service-Center-UI-Preview.gif | Bin 0 -> 616202 bytes
.../zh_CN/static_files/communication.PNG | Bin 0 -> 26597 bytes
.../zh_CN/static_files/integration-grafana.PNG | Bin 0 -> 74642 bytes
.../zh_CN/static_files/onStartup.PNG | Bin 0 -> 28938 bytes
.../zh_CN/static_files/tracing-file.PNG | Bin 0 -> 32339 bytes
.../zh_CN/static_files/tracing-server.PNG | Bin 0 -> 32308 bytes
84 files changed, 11621 insertions(+)
diff --git a/saga-reference/LANGS.md b/saga-reference/LANGS.md
new file mode 100644
index 0000000..4106f21
--- /dev/null
+++ b/saga-reference/LANGS.md
@@ -0,0 +1,2 @@
+* [英文](en_US/)
+* [中文](zh_CN/)
\ No newline at end of file
diff --git a/saga-reference/en_US/README.md b/saga-reference/en_US/README.md
new file mode 100644
index 0000000..58a2b2b
--- /dev/null
+++ b/saga-reference/en_US/README.md
@@ -0,0 +1,133 @@
+# Saga User Guide
+[](user_guide_zh.md)
+
+## Prerequisites
+You will need:
+1. [JDK 1.8][jdk]
+2. [Maven 3.x][maven]
+3. [Docker][docker]
+
+[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+[maven]: https://maven.apache.org/install.html
+[docker]: https://www.docker.com/get-docker
+
+## Build
+
+Retrieve the source code:
+```bash
+$ git clone https://github.com/apache/incubator-servicecomb-saga.git
+$ cd incubator-servicecomb-saga
+```
+
+Saga can be built in either of the following ways.
+* Only build the executable files.
+ ```bash
+ $ mvn clean install -DskipTests
+ ```
+
+* build the executable files along with docker image.
+ ```bash
+ $ mvn clean install -DskipTests -Pdocker
+ ```
+
+* build the executable file and saga-distribution
+ ```bash
+ $ mvn clean install -DskipTests -Prelease
+ ```
+
+After executing either one of the above command, you will find alpha server's executable file in `alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`.
+
+## How to use
+### Add saga dependencies
+```xml
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-spring-starter</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-transport-resttemplate</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+```
+**Note**: Please change the `${saga.version}` to the actual version.
+
+### Add saga annotations and corresponding compensation methods
+Take a transfer money application as an example:
+1. add `@EnableOmega` at application entry to initialize omega configurations and connect to alpha
+ ```java
+ @SpringBootApplication
+ @EnableOmega
+ public class Application {
+ public static void main(String[] args) {
+ SpringApplication.run(Application.class, args);
+ }
+ }
+ ```
+
+2. add `@SagaStart` at the starting point of the global transaction
+ ```java
+ @SagaStart(timeout=10)
+ public boolean transferMoney(String from, String to, int amount) {
+ transferOut(from, amount);
+ transferIn(to, amount);
+ }
+ ```
+ **Note:** By default, timeout is disable.
+
+3. add `@Compensable` at the sub-transaction and specify its corresponding compensation method
+ ```java
+ @Compensable(timeout=5, compensationMethod="cancel")
+ public boolean transferOut(String from, int amount) {
+ repo.reduceBalanceByUsername(from, amount);
+ }
+
+ public boolean cancel(String from, int amount) {
+ repo.addBalanceByUsername(from, amount);
+ }
+ ```
+
+ **Note** transactions and compensations implemented by services must be idempotent.
+
+ **Note:** By default, timeout is disable.
+
+ **Note:** If the starting point of global transaction and local transaction overlaps, both `@SagaStart` and `@Compensable` are needed.
+
+4. Repeat step 3 for the `transferIn` service.
+
+## How to run
+1. run postgreSQL.
+ ```bash
+ docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
+ ```
+
+2. run alpha. Before running alpha, please make sure postgreSQL is already up. You can run alpha through docker or executable file.
+ * Run alpha through docker.
+ ```bash
+ docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * Run alpha through executable file.
+ ```bash
+ java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+
+ **Note**: Please change `${saga_version}` and `${host_address}` to the actual value before you execute the command.
+
+ **Note**: By default, port 8080 is used to serve omega's request via gRPC while port 8090 is used to query the events stored in alpha.
+
+3. setup omega. Configure the following values in `application.yaml`.
+ ```yaml
+ spring:
+ application:
+ name: {application.name}
+ alpha:
+ cluster:
+ address: {alpha.cluster.addresses}
+ ```
+
+Then you can start your micro-services and access all saga events via http://${alpha-server:port}/events.
+
+## Enable SSL for Alpha and Omega
+
+See [Enabling SSL](enable_ssl.md) for details.
diff --git a/saga-reference/en_US/SUMMARY.md b/saga-reference/en_US/SUMMARY.md
new file mode 100644
index 0000000..3def406
--- /dev/null
+++ b/saga-reference/en_US/SUMMARY.md
@@ -0,0 +1,9 @@
+# 目录
+
+* [Guide](user_guide.md)
+* [Design](design.md)
+* [TLS](enable_ssl.md)
+* [API](api/api.md)
+* [Q&A](faq/how_to_use_mysql_as_alpha_backend_database.md)
+
+
diff --git a/saga-reference/en_US/api/api.md b/saga-reference/en_US/api/api.md
new file mode 100755
index 0000000..e0a9e8f
--- /dev/null
+++ b/saga-reference/en_US/api/api.md
@@ -0,0 +1,168 @@
+# Saga API
+### Post transaction and compensation requests to Saga
+```
+POST /requests
+```
+
+#### Description
+
+1. Define requests in order and recovery policy by JSON format as below,put them to body.
+```
+{
+ "policy": "",
+ "requests": [
+ {
+ "id": "",
+ "type": "",
+ "serviceName": "",
+ "parents": [
+
+ ],
+ "transaction": {
+ "method": "",
+ "path": "",
+ "params": {
+
+ }
+ },
+ "compensation": {
+ "method": "",
+ "path": "",
+ "params": {
+
+ }
+ }
+ }
+ ]
+}
+```
+JSON parameters:
+- policy - support `BackwardRecovery` or `ForwardRecovery`.
+- requests - transactions array.
+ - id - request id. It should be unique among this collection of requests.
+ - type - support `rest` for now.
+ - serviceName - user-defined service name.
+ - parents - request ids. It means this request is only executed after all requests in the parents field are completed.
+ - transaction - user-defined transaction that executed by the Saga.
+ - method - user-defined, HTTP method.
+ - path - user-defined, HTTP path.
+ - params - support `form`,`json`,`body`,`query`.
+ - compensation - user-defined compensation that executed by the Saga.
+ - method - user-defined, HTTP method.
+ - path - user-defined, HTTP path.
+ - params - support `form`,`json`,`body`,`query`.
+
+2. Set content type to `text/plain`.
+
+3. Send them to Saga service.
+
+#### Example request
+```
+curl -XPOST -H "Content-Type: text/plain" -d @./request.json http://<docker.host.ip:saga.port>/requests
+```
+
+#### Example response
+```
+success
+```
+
+#### Status codes
+- **200** – no error
+- **400** – bad parameter
+- **500** – server error
+
+
+### Get all the Saga events
+```
+GET /events
+```
+
+#### Description
+Get all the Saga events.
+
+#### Example request
+```
+curl -XGET http://<docker.host.ip:saga.port>/events
+```
+
+#### Example response
+```
+{
+ "88658e73-eff5-4d31-887e-019201d6b560": [
+ {
+ "id": 1,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "SagaStartedEvent",
+ "contentJson": "{\"policy\": \"BackwardRecovery\", \"requests\": [{\"id\": \"request-car\", \"type\": \"rest\", \"serviceName\": \"car-rental-service\", \"transaction\": {\"path\": \"/rentals\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/rentals\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}}, {\"id\": \"request-hotel\", \"type\": \"rest\", \"serviceName\": \"hotel-reservation-service [...]
+ },
+ {
+ "id": 2,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-flight\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"flight-booking-service\", \"transaction\": {\"path\": \"/bookings\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/bookings\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 3,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-car\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"car-rental-service\", \"transaction\": {\"path\": \"/rentals\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/rentals\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 4,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-hotel\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"hotel-reservation-service\", \"transaction\": {\"path\": \"/reservations\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/reservations\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 5,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-flight\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"flight-booking-service\", \"transaction\": {\"path\": \"/bookings\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/bookings\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"response\": {\"body\": \"{\\n \\\"statusCode\\\" [...]
+ },
+ {
+ "id": 6,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-hotel\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"hotel-reservation-service\", \"transaction\": {\"path\": \"/reservations\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/reservations\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"response\": {\"body\": \"{\\n \\\"stat [...]
+ },
+ {
+ "id": 7,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-car\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"car-rental-service\", \"transaction\": {\"path\": \"/rentals\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/rentals\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"response\": {\"body\": \"{\\n \\\"statusCode\\\": 200,\\n [...]
+ },
+ {
+ "id": 8,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-payment\", \"type\": \"rest\", \"parents\": [\"request-car\", \"request-flight\", \"request-hotel\"], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"payment-service\", \"transaction\": {\"path\": \"/payments\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/payments\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 9,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-payment\", \"type\": \"rest\", \"parents\": [\"request-car\", \"request-flight\", \"request-hotel\"], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"payment-service\", \"transaction\": {\"path\": \"/payments\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/payments\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"r [...]
+ },
+ {
+ "id": 10,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "SagaEndedEvent",
+ "contentJson": "{}"
+ }
+ ]
+}
+```
+
+#### Status codes
+- **200** – no error
+
diff --git a/saga-reference/en_US/book.json b/saga-reference/en_US/book.json
new file mode 100644
index 0000000..3fc33db
--- /dev/null
+++ b/saga-reference/en_US/book.json
@@ -0,0 +1,5 @@
+{
+ "structure": {
+ "readme": "user_guide.md"
+ }
+}
\ No newline at end of file
diff --git a/saga-reference/en_US/design.md b/saga-reference/en_US/design.md
new file mode 100644
index 0000000..a1e0143
--- /dev/null
+++ b/saga-reference/en_US/design.md
@@ -0,0 +1,46 @@
+# Saga Pack Design
+[](design_zh.md)
+## Overview
+Pack contains two components: *alpha* and *omega*. Alpha is the pack leader and backed by database to make sure transaction events stored permanently while omega is the pack worker and embedded inside services to intercept transaction invocation and report events to alpha.
+
+
+
+## Omega Internal
+Omega plays as an embedded agent inside services. When a service request arrives, omega intercepts its header and retrieve the global transaction id as its global transaction id (Saga event id) and retrieve the local transaction id as its parent transaction id. In pre-process phase, a transaction started event will be recorded in alpha. In post-process phase, a transaction ended event will be recorded in alpha to mark the end of the sub-transaction.
+
+
+
+## Inter-Service Communication
+The process of Inter-Service Communication is similar to [Zipkin](https://github.com/openzipkin/zipkin)'s. In the producer side, omega intercepts the transaction ids from request to retrieve the transaction context. In the consumer side, omega inject the global transaction ids into request to pass the transaction context. Sub-transactions can chain as a single global transaction by co-operating producers and consumers.
+
+
+
+## Workflow Saga
+Saga处理场景是要求相关的子事务提供事务处理函数同时也提供补偿函数。Saga协调器alpha会根据事务的执行情况向omega发送相关的指令，确定是否向前重试或者向后恢复。
+### Successful Scenario
+In a successful scenario, all started events will have a corresponding ended event.
+
+
+
+### Exception Scenario
+In an exception scenario, omega inside the abnormal service will report an aborted event to alpha. Apha will then send compensate commands to the completed events within the global transaction to make sure all sub-transactions are either completed or rollbacked.
+
+
+
+### Timeout Scenario
+In timeout scenario, timeouted events will be detected by alpha's period scanner, the corresponding global transaction will be abort at the same time.
+
+
+
+## Workflow TCC
+Comparing Saga, TCC(try-confirm-cancel) just have one more method(try) to check if we have enough resource to finish the transaction.
+ The transaction starter knows all the distributed sub transactions status, so it can work with alpha to confirm or cancel the transactions。
+### Successful Scenario
+In a successful scenario, all try events are confirmed.
+
+
+
+### Exception Scenario
+In an exception scenario, the starter will send the cancel event to alpha, and alpha could invoke the cancel methods which are registered to the Alpha server to clean up the pre allocated resources.
+
+
diff --git a/saga-reference/en_US/enable_ssl.md b/saga-reference/en_US/enable_ssl.md
new file mode 100644
index 0000000..759ccb0
--- /dev/null
+++ b/saga-reference/en_US/enable_ssl.md
@@ -0,0 +1,87 @@
+# Enable TLS for omega-alpha communication
+
+Saga now supports TLS for communication between omega and alpha server. Client side authentication(Mutual authentication) is also supported.
+
+## Prepare Certificates
+
+You can use the following commands to generate self-signed certificates for testing.
+
+The client certificates is only needed if you want to use mutual authentication.
+
+
+```
+# Changes these CN's to match your hosts in your environment if needed.
+SERVER_CN=localhost
+CLIENT_CN=localhost # Used when doing mutual TLS
+
+echo Generate CA key:
+openssl genrsa -passout pass:1111 -des3 -out ca.key 4096
+echo Generate CA certificate:
+# Generates ca.crt which is the trustCertCollectionFile
+openssl req -passin pass:1111 -new -x509 -days 365 -key ca.key -out ca.crt -subj "/CN=${SERVER_CN}"
+echo Generate server key:
+openssl genrsa -passout pass:1111 -des3 -out server.key 4096
+echo Generate server signing request:
+openssl req -passin pass:1111 -new -key server.key -out server.csr -subj "/CN=${SERVER_CN}"
+echo Self-signed server certificate:
+# Generates server.crt which is the certChainFile for the server
+openssl x509 -req -passin pass:1111 -days 365 -in server.csr -CA ca.crt -CAkey ca.key -set_serial 01 -out server.crt
+echo Remove passphrase from server key:
+openssl rsa -passin pass:1111 -in server.key -out server.key
+echo Generate client key
+openssl genrsa -passout pass:1111 -des3 -out client.key 4096
+echo Generate client signing request:
+openssl req -passin pass:1111 -new -key client.key -out client.csr -subj "/CN=${CLIENT_CN}"
+echo Self-signed client certificate:
+# Generates client.crt which is the clientCertChainFile for the client (need for mutual TLS only)
+openssl x509 -passin pass:1111 -req -days 365 -in client.csr -CA ca.crt -CAkey ca.key -set_serial 01 -out client.crt
+echo Remove passphrase from client key:
+openssl rsa -passin pass:1111 -in client.key -out client.key
+echo Converting the private keys to X.509:
+# Generates client.pem which is the clientPrivateKeyFile for the Client (needed for mutual TLS only)
+openssl pkcs8 -topk8 -nocrypt -in client.key -out client.pem
+# Generates server.pem which is the privateKeyFile for the Server
+openssl pkcs8 -topk8 -nocrypt -in server.key -out server.pem
+```
+
+## Enable TLS for Alpha Server
+
+1. Edit the application.yaml file for alpha-server, add the ssl configuration under the `alpha.server` section.
+
+```
+alpha:
+ server:
+ ssl:
+ enable: true
+ cert: server.crt
+ key: server.pem
+ mutualAuth: true
+ clientCert: client.crt
+```
+
+2. Put the server.crt and server.pem files under the root directory of the alpha-server. If you want to use mutual authentication, Merge all the client certificates into one file client.crt, then put the client.crt under the root directory.
+
+3. Restart alpha-server.
+
+
+## Enable TLS for Omega
+
+1. Get the CA certificate chain, you may need to merge multiple CA certificates into one file if you are running alpha server in cluster.
+
+2. Edit the application.yaml file for the client application, add the ssl configuration under the `alpha.cluster` section.
+
+```
+alpha:
+ cluster:
+ address: alpha-server.servicecomb.io:8080
+ ssl:
+ enable: false
+ certChain: ca.crt
+ mutualAuth: false
+ cert: client.crt
+ key: client.pem
+```
+3. Put the ca.crt file under the client application root directory. If you want to use mutual authentication, also put the client.crt and client.pem under the root directory.
+
+4. Restart the client application.
+
diff --git a/saga-reference/en_US/faq/how_to_use_mysql_as_alpha_backend_database.md b/saga-reference/en_US/faq/how_to_use_mysql_as_alpha_backend_database.md
new file mode 100644
index 0000000..c63a1de
--- /dev/null
+++ b/saga-reference/en_US/faq/how_to_use_mysql_as_alpha_backend_database.md
@@ -0,0 +1,43 @@
+**Problem:** How to use MySQL as alpha's backend database?
+
+**Solution:** To replace the default database from postgreSQL to MySQL:
+1. add dependency of `mysql-connector-java` in `alpha/alpha-server/pom.xml`
+ ```xml
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ </dependency>
+ ```
+
+2. install Saga
+ ```bash
+ mvn clean package -Pdocker -DskipTests
+ ```
+ After that, you will find the generated docker image `alpha-server` and executable file `alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`.
+
+ **Notice**: If you do not want to build the docker image, run `mvn clean package -DskipTests` is enough.
+
+ **Notice**: If you have installed saga with docker before, you need to remove the alpha-server's docker image first.
+ ```bash
+ docker rmi -f $(docker images | grep alpha-server | awk '{print $3}')
+ ```
+
+3. run MySQL
+ ```bash
+ docker run -d -e "MYSQL_ROOT_PASSWORD=password" -e "MYSQL_DATABASE=saga" -e "MYSQL_USER=saga" -e "MYSQL_PASSWORD=password" -p 3306:3306 mysql/mysql-server:5.7
+ ```
+
+4. Run alpha. Please make sure MySQL is up before this step. You can run alpha through docker or executable file.
+ * via docker
+ ```bash
+ docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=mysql -Dspring.datasource.url=jdbc:mysql://${host_address}:3306/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * via executable file
+ ```bash
+ java -Dspring.profiles.active=mysql -D"spring.datasource.url=jdbc:mysql://${host_address}:3306/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+
+ **Notice**: Please change `${saga_version}` and `${host_address}` to the actual value before you execute the command.
+
+
+ **Note**: By default, port 8080 is used to serve omega's request via gRPC while port 8090 is used to query the events stored in alpha.
diff --git a/saga-reference/en_US/old_saga.md b/saga-reference/en_US/old_saga.md
new file mode 100755
index 0000000..2b79d22
--- /dev/null
+++ b/saga-reference/en_US/old_saga.md
@@ -0,0 +1,53 @@
+# Previous Saga's Documentation
+## Major Architecture of Saga
+* saga-core(transaction and compensation handling logic)
+* saga-format(data serialization and deserialization)
+* saga-transports(communication protocol implementation such as rest or rpc in the future)
+* saga-discovery(service discovery)
+* saga-spring(restful service framework)
+
+
+
+## Prerequisites
+You will need:
+1. [Oracle JDK 1.8+][jdk]
+2. [Maven 3.x][maven]
+3. [Docker][docker]
+4. [PostgreSQL][postgres]
+5. [Service Center(optional)][service_center]
+6. [Docker compose(optional)][docker_compose]
+7. [Docker machine(optional)][docker_machine]
+
+[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+[maven]: https://maven.apache.org/install.html
+[docker]: https://www.docker.com/get-docker
+[postgres]: https://www.postgresql.org/download/
+[service_center]: https://github.com/apache/incubator-servicecomb-service-center
+[docker_compose]: https://docs.docker.com/compose/install/
+[docker_machine]: https://docs.docker.com/machine/install-machine/
+
+## Building
+Download the source code.
+```
+git clone https://github.com/apache/incubator-servicecomb-saga.git
+```
+
+Enter the Saga root directory,build Saga project by maven command and generate a docker image named saga-spring in local.
+```
+mvn package -DskipTests -Pdocker
+```
+
+## Run Services
+A `docker-compose.yaml` file is provided to start Saga services and its dependencies(Service center and Mysql) as docker containers.
+User also can configure specified Service center or Mysql in `docker-compose.yaml`.
+
+Enter the Saga root directory, run all service images using command,
+```
+docker-compose up
+```
+
+## Reference API
+See [Saga API](docs/api/api.md) for details.
+
+## Example
+See [Saga demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo) for details.
diff --git a/saga-reference/en_US/static_files/exception_scenario.png b/saga-reference/en_US/static_files/exception_scenario.png
new file mode 100644
index 0000000..a8738ba
Binary files /dev/null and b/saga-reference/en_US/static_files/exception_scenario.png differ
diff --git a/saga-reference/en_US/static_files/exception_scenario_TCC.png b/saga-reference/en_US/static_files/exception_scenario_TCC.png
new file mode 100644
index 0000000..4753558
Binary files /dev/null and b/saga-reference/en_US/static_files/exception_scenario_TCC.png differ
diff --git a/saga-reference/en_US/static_files/inter-service_communication.png b/saga-reference/en_US/static_files/inter-service_communication.png
new file mode 100644
index 0000000..11d8dff
Binary files /dev/null and b/saga-reference/en_US/static_files/inter-service_communication.png differ
diff --git a/saga-reference/en_US/static_files/omega_internal.png b/saga-reference/en_US/static_files/omega_internal.png
new file mode 100644
index 0000000..1f130a2
Binary files /dev/null and b/saga-reference/en_US/static_files/omega_internal.png differ
diff --git a/saga-reference/en_US/static_files/pack.png b/saga-reference/en_US/static_files/pack.png
new file mode 100644
index 0000000..2c30c00
Binary files /dev/null and b/saga-reference/en_US/static_files/pack.png differ
diff --git a/saga-reference/en_US/static_files/saga.png b/saga-reference/en_US/static_files/saga.png
new file mode 100755
index 0000000..39460c3
Binary files /dev/null and b/saga-reference/en_US/static_files/saga.png differ
diff --git a/saga-reference/en_US/static_files/successful_scenario.png b/saga-reference/en_US/static_files/successful_scenario.png
new file mode 100644
index 0000000..5dd8850
Binary files /dev/null and b/saga-reference/en_US/static_files/successful_scenario.png differ
diff --git a/saga-reference/en_US/static_files/successful_scenario_TCC.png b/saga-reference/en_US/static_files/successful_scenario_TCC.png
new file mode 100644
index 0000000..dc44f35
Binary files /dev/null and b/saga-reference/en_US/static_files/successful_scenario_TCC.png differ
diff --git a/saga-reference/en_US/static_files/timeout_scenario.png b/saga-reference/en_US/static_files/timeout_scenario.png
new file mode 100644
index 0000000..998cfcf
Binary files /dev/null and b/saga-reference/en_US/static_files/timeout_scenario.png differ
diff --git a/saga-reference/en_US/user_guide.md b/saga-reference/en_US/user_guide.md
new file mode 100644
index 0000000..293004b
--- /dev/null
+++ b/saga-reference/en_US/user_guide.md
@@ -0,0 +1,136 @@
+# Saga User Guide
+[](user_guide_zh.md)
+
+## Prerequisites
+You will need:
+1. [JDK 1.8][jdk]
+2. [Maven 3.x][maven]
+3. [Docker][docker]
+
+[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+[maven]: https://maven.apache.org/install.html
+[docker]: https://www.docker.com/get-docker
+
+## Build
+
+Retrieve the source code:
+```bash
+$ git clone https://github.com/apache/incubator-servicecomb-saga.git
+$ cd incubator-servicecomb-saga
+```
+
+Saga can be built in either of the following ways.
+* Only build the executable files.
+ ```bash
+ $ mvn clean install -DskipTests
+ ```
+
+* build the executable files along with docker image.
+ ```bash
+ $ mvn clean install -DskipTests -Pdocker
+ ```
+
+* build the executable file and saga-distribution
+ ```bash
+ $ mvn clean install -DskipTests -Prelease
+ ```
+
+After executing either one of the above command, you will find alpha server's executable file in `alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`.
+
+## How to use
+### Add saga dependencies
+```xml
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-spring-starter</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-transport-resttemplate</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+```
+**Note**: Please change the `${saga.version}` to the actual version.
+
+### Add saga annotations and corresponding compensation methods
+Take a transfer money application as an example:
+1. add `@EnableOmega` at application entry to initialize omega configurations and connect to alpha
+ ```java
+ @SpringBootApplication
+ @EnableOmega
+ public class Application {
+ public static void main(String[] args) {
+ SpringApplication.run(Application.class, args);
+ }
+ }
+ ```
+
+2. add `@SagaStart` at the starting point of the global transaction
+ ```java
+ @SagaStart(timeout=10)
+ public boolean transferMoney(String from, String to, int amount) {
+ transferOut(from, amount);
+ transferIn(to, amount);
+ }
+ ```
+ **Note:** By default, timeout is disable.
+
+3. add `@Compensable` at the sub-transaction and specify its corresponding compensation method
+ ```java
+ @Compensable(timeout=5, compensationMethod="cancel")
+ public boolean transferOut(String from, int amount) {
+ repo.reduceBalanceByUsername(from, amount);
+ }
+
+ public boolean cancel(String from, int amount) {
+ repo.addBalanceByUsername(from, amount);
+ }
+ ```
+
+ **Note** transactions and compensations implemented by services must be idempotent.
+
+ **Note:** By default, timeout is disable.
+
+ **Note:** If the starting point of global transaction and local transaction overlaps, both `@SagaStart` and `@Compensable` are needed.
+
+4. Repeat step 3 for the `transferIn` service.
+
+5. Since Saga-0.3.0, you can access the [OmegaContext](https://github.com/apache/incubator-servicecomb-saga/blob/master/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java) for the gloableTxId and localTxId in the @Compensable annotated method or the cancel method.
+
+## How to run
+1. run postgreSQL.
+ ```bash
+ docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
+ ```
+ Please check out [this document](https://github.com/apache/incubator-servicecomb-saga/blob/master/docs/faq/en/how_to_use_mysql_as_alpha_backend_database.md), if you want to use the MySQL instead of postgreSQL.
+
+2. run alpha. Before running alpha, please make sure postgreSQL is already up. You can run alpha through docker or executable file.
+ * Run alpha through docker.
+ ```bash
+ docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * Run alpha through executable file.
+ ```bash
+ java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+
+ **Note**: Please change `${saga_version}` and `${host_address}` to the actual value before you execute the command.
+
+ **Note**: By default, port 8080 is used to serve omega's request via gRPC while port 8090 is used to query the events stored in alpha.
+
+3. setup omega. Configure the following values in `application.yaml`.
+ ```yaml
+ spring:
+ application:
+ name: {application.name}
+ alpha:
+ cluster:
+ address: {alpha.cluster.addresses}
+ ```
+
+Then you can start your micro-services and access all saga events via http://${alpha-server:port}/events.
+
+## Enable SSL for Alpha and Omega
+
+See [Enabling SSL](enable_ssl.md) for details.
diff --git a/saga-reference/zh_CN/README.md b/saga-reference/zh_CN/README.md
new file mode 100644
index 0000000..4331001
--- /dev/null
+++ b/saga-reference/zh_CN/README.md
@@ -0,0 +1,131 @@
+# Saga 用户指南
+[](user_guide.md)
+
+## 准备环境
+1. 安装[JDK 1.8][jdk]
+2. 安装[Maven 3.x][maven]
+3. 安装[Docker][docker]
+
+[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+[maven]: https://maven.apache.org/install.html
+[docker]: https://www.docker.com/get-docker
+
+## 编译
+
+获取源码：
+```bash
+$ git clone https://github.com/apache/incubator-servicecomb-saga.git
+$ cd incubator-servicecomb-saga
+```
+
+Saga可通过以下任一方式进行构建：
+* 只构建可执行文件：
+ ```bash
+ $ mvn clean install -DskipTests
+ ```
+
+* 同时构建可执行文件和docker镜像：
+ ```bash
+ $ mvn clean install -DskipTests -Pdocker
+ ```
+
+* 同时构建可执行文件以及Saga发行包
+ ```bash
+ $ mvn clean install -DskipTests -Prelease
+ ```
+
+
+在执行以上任一指令后，可在`alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`中找到alpha server的可执行文件。
+
+## 如何使用
+### 引入Saga的依赖
+```xml
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-spring-starter</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-transport-resttemplate</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+```
+**注意**: 请将`${saga.version}`更改为实际的版本号。
+
+### 添加Saga的注解及相应的补偿方法
+以一个转账应用为例：
+1. 在应用入口添加 `@EnableOmega` 的注解来初始化omega的配置并与alpha建立连接。
+ ```java
+ @SpringBootApplication
+ @EnableOmega
+ public class Application {
+ public static void main(String[] args) {
+ SpringApplication.run(Application.class, args);
+ }
+ }
+ ```
+
+2. 在全局事务的起点添加 `@SagaStart` 的注解。
+ ```java
+ @SagaStart(timeout=10)
+ public boolean transferMoney(String from, String to, int amount) {
+ transferOut(from, amount);
+ transferIn(to, amount);
+ }
+ ```
+ **注意:** 默认情况下，超时设置需要显式声明才生效。
+
+3. 在子事务处添加 `@Compensable` 的注解并指明其对应的补偿方法。
+ ```java
+ @Compensable(timeout=5, compensationMethod="cancel")
+ public boolean transferOut(String from, int amount) {
+ repo.reduceBalanceByUsername(from, amount);
+ }
+
+ public boolean cancel(String from, int amount) {
+ repo.addBalanceByUsername(from, amount);
+ }
+ ```
+
+ **注意:** 实现的服务和补偿必须满足幂等的条件。
+
+ **注意:** 默认情况下，超时设置需要显式声明才生效。
+
+ **注意:** 若全局事务起点与子事务起点重合，需同时声明 `@SagaStart` 和 `@Compensable` 的注解。
+
+4. 对转入服务重复第三步即可。
+
+## 如何运行
+1. 运行postgreSQL
+ ```bash
+ docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
+ ```
+
+2. 运行alpha。在运行alpha前，请确保postgreSQL已正常启动。可通过docker或可执行文件的方式来启动alpha。
+ * 通过docker运行：
+ ```bash
+ docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * 通过可执行文件运行：
+ ```bash
+ java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+
+ **注意**: 请在执行命令前将`${saga_version}`和`${host_address}`更改为实际值。
+
+
+ **注意**: 默认情况下，8080端口用于处理omega处发起的gRPC的请求，而8090端口用于处理查询存储在alpha处的事件信息。
+
+
+3. 配置omega。在 `application.yaml` 添加下面的配置项：
+ ```yaml
+ spring:
+ application:
+ name: {application.name}
+ alpha:
+ cluster:
+ address: {alpha.cluster.addresses}
+ ```
+
+然后就可以运行相关的微服务了，可通过访问http://${alpha-server:port}/events 来获取所有的saga事件信息。
diff --git a/saga-reference/zh_CN/SUMMARY.md b/saga-reference/zh_CN/SUMMARY.md
new file mode 100644
index 0000000..d761f77
--- /dev/null
+++ b/saga-reference/zh_CN/SUMMARY.md
@@ -0,0 +1,9 @@
+# 目录
+
+* [用户手册](user_guide_zh.md)
+* [设计文档](design.md)
+* [TLS通信](enable_ssl.md)
+* [API](api/api.md)
+* [Q&A](faq/how_to_use_mysql_as_alpha_backend_database_zh.md)
+
+
diff --git a/saga-reference/zh_CN/api/api.md b/saga-reference/zh_CN/api/api.md
new file mode 100755
index 0000000..a992e4d
--- /dev/null
+++ b/saga-reference/zh_CN/api/api.md
@@ -0,0 +1,170 @@
+# Saga API
+### 对saga的Pos处理及请求
+```
+POST /requests
+```
+
+#### 描述
+
+1. 根据JSON格式按顺序定义请求和恢复策略，按照下面的示例，将它们放到http body中。
+
+
+```
+{
+ "policy": "",
+ "requests": [
+ {
+ "id": "",
+ "type": "",
+ "serviceName": "",
+ "parents": [
+
+ ],
+ "transaction": {
+ "method": "",
+ "path": "",
+ "params": {
+
+ }
+ },
+ "compensation": {
+ "method": "",
+ "path": "",
+ "params": {
+
+ }
+ }
+ }
+ ]
+}
+```
+JSON parameters:
+- policy - support `BackwardRecovery` or `ForwardRecovery`.
+- requests - transactions array.
+ - id - request id. It should be unique among this collection of requests.
+ - type - support `rest` for now.
+ - serviceName - user-defined service name.
+ - parents - request ids. It means this request is only executed after all requests in the parents field are completed.
+ - transaction - user-defined transaction that executed by the Saga.
+ - method - user-defined, HTTP method.
+ - path - user-defined, HTTP path.
+ - params - support `form`,`json`,`body`,`query`.
+ - compensation - user-defined compensation that executed by the Saga.
+ - method - user-defined, HTTP method.
+ - path - user-defined, HTTP path.
+ - params - support `form`,`json`,`body`,`query`.
+
+2. 设置content type到 `text/plain`.
+
+3. 发送他们到Saga service.
+
+#### request的例子
+```
+curl -XPOST -H "Content-Type: text/plain" -d @./request.json http://<docker.host.ip:saga.port>/requests
+```
+
+#### response的例子
+```
+success
+```
+
+#### Status codes
+- **200** – no error
+- **400** – bad parameter
+- **500** – server error
+
+
+### 获取全部Saga事件
+```
+GET /events
+```
+
+#### 秒偶数
+获取全部Saga事件
+
+#### request的例子
+```
+curl -XGET http://<docker.host.ip:saga.port>/events
+```
+
+#### response的例子
+```
+{
+ "88658e73-eff5-4d31-887e-019201d6b560": [
+ {
+ "id": 1,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "SagaStartedEvent",
+ "contentJson": "{\"policy\": \"BackwardRecovery\", \"requests\": [{\"id\": \"request-car\", \"type\": \"rest\", \"serviceName\": \"car-rental-service\", \"transaction\": {\"path\": \"/rentals\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/rentals\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}}, {\"id\": \"request-hotel\", \"type\": \"rest\", \"serviceName\": \"hotel-reservation-service [...]
+ },
+ {
+ "id": 2,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-flight\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"flight-booking-service\", \"transaction\": {\"path\": \"/bookings\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/bookings\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 3,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-car\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"car-rental-service\", \"transaction\": {\"path\": \"/rentals\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/rentals\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 4,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-hotel\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"hotel-reservation-service\", \"transaction\": {\"path\": \"/reservations\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/reservations\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 5,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-flight\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"flight-booking-service\", \"transaction\": {\"path\": \"/bookings\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/bookings\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"response\": {\"body\": \"{\\n \\\"statusCode\\\" [...]
+ },
+ {
+ "id": 6,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:40Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-hotel\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"hotel-reservation-service\", \"transaction\": {\"path\": \"/reservations\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/reservations\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"response\": {\"body\": \"{\\n \\\"stat [...]
+ },
+ {
+ "id": 7,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-car\", \"type\": \"rest\", \"parents\": [], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"car-rental-service\", \"transaction\": {\"path\": \"/rentals\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/rentals\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"response\": {\"body\": \"{\\n \\\"statusCode\\\": 200,\\n [...]
+ },
+ {
+ "id": 8,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "TransactionStartedEvent",
+ "contentJson": "{\"id\": \"request-payment\", \"type\": \"rest\", \"parents\": [\"request-car\", \"request-flight\", \"request-hotel\"], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"payment-service\", \"transaction\": {\"path\": \"/payments\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/payments\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}"
+ },
+ {
+ "id": 9,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "TransactionEndedEvent",
+ "contentJson": "{\"request\": {\"id\": \"request-payment\", \"type\": \"rest\", \"parents\": [\"request-car\", \"request-flight\", \"request-hotel\"], \"fallback\": {\"type\": \"NOP\"}, \"serviceName\": \"payment-service\", \"transaction\": {\"path\": \"/payments\", \"method\": \"post\", \"params\": {\"form\": {\"customerId\": \"mike\"}}}, \"compensation\": {\"path\": \"/payments\", \"method\": \"put\", \"params\": {\"form\": {\"customerId\": \"mike\"}}, \"retries\": 3}}, \"r [...]
+ },
+ {
+ "id": 10,
+ "sagaId": "88658e73-eff5-4d31-887e-019201d6b560",
+ "creationTime": "2017-09-15T01:15:41Z",
+ "type": "SagaEndedEvent",
+ "contentJson": "{}"
+ }
+ ]
+}
+```
+
+#### Status codes
+- **200** – no error
+
diff --git a/saga-reference/zh_CN/book.json b/saga-reference/zh_CN/book.json
new file mode 100644
index 0000000..c0fca37
--- /dev/null
+++ b/saga-reference/zh_CN/book.json
@@ -0,0 +1,5 @@
+{
+ "structure": {
+ "readme": "user_guide_zh.md"
+ }
+}
\ No newline at end of file
diff --git a/saga-reference/zh_CN/design_zh.md b/saga-reference/zh_CN/design_zh.md
new file mode 100644
index 0000000..7659755
--- /dev/null
+++ b/saga-reference/zh_CN/design_zh.md
@@ -0,0 +1,47 @@
+# Saga Pack 设计文档
+[](design.md)
+## 概览
+Pack中包含两个组件，即 **alpha** 和 **omega**。
+* alpha充当协调者的角色，主要负责对事务的事件进行持久化存储以及协调子事务的状态，使其得以最终与全局事务的状态保持一致。
+* omega是微服务中内嵌的一个agent，负责对网络请求进行拦截并向alpha上报事务事件，并在异常情况下根据alpha下发的指令执行相应的补偿操作。
+
+
+
+## Omega内部运行机制
+omega是微服务中内嵌的一个agent。当服务收到请求时，omega会将其拦截并从中提取请求信息中的全局事务id作为其自身的全局事务id（即Saga事件id），并提取本地事务id作为其父事务id。在预处理阶段，alpha会记录事务开始的事件；在后处理阶段，alpha会记录事务结束的事件。因此，每个成功的子事务都有一一对应的开始及结束事件。
+
+
+
+## 服务间通信流程
+服务间通信的流程与[Zipkin](https://github.com/openzipkin/zipkin)的类似。在服务生产方，omega会拦截请求中事务相关的id来提取事务的上下文。在服务消费方，omega会在请求中注入事务相关的id来传递事务的上下文。通过服务提供方和服务消费方的这种协作处理，子事务能连接起来形成一个完整的全局事务。
+
+
+
+## Saga 具体处理流程
+Saga处理场景是要求相关的子事务提供事务处理函数同时也提供补偿函数。Saga协调器alpha会根据事务的执行情况向omega发送相关的指令，确定是否向前重试或者向后恢复。
+### 成功场景
+成功场景下，每个事务都会有开始和有对应的结束事件。
+
+
+
+### 异常场景
+异常场景下，omega会向alpha上报中断事件，然后alpha会向该全局事务的其它已完成的子事务发送补偿指令，确保最终所有的子事务要么都成功，要么都回滚。
+
+
+
+### 超时场景 (需要调整）
+超时场景下，已超时的事件会被alpha的定期扫描器检测出来，与此同时，该超时事务对应的全局事务也会被中断。
+
+
+
+## TCC 具体处理流程
+TCC(try-confirm-cancel)与Saga事务处理方式相比多了一个Try方法。事务调用的发起方来根据事务的执行情况协调各方相关各方进行提交事务或者回滚事务。
+### 成功场景
+成功场景下， 每个事务都会有开始和对应的结束事件
+
+
+
+### 异常场景
+异常场景下，事务发起方会向alpha上报异常事件，然后alpha会向该全局事务的其它已完成的子事务发送补偿指令，确保最终所有的子事务要么都成功，要么都回滚。
+
+
diff --git a/saga-reference/zh_CN/enable_ssl.md b/saga-reference/zh_CN/enable_ssl.md
new file mode 100644
index 0000000..43c7d57
--- /dev/null
+++ b/saga-reference/zh_CN/enable_ssl.md
@@ -0,0 +1,84 @@
+# TLS 对 omega-alpha 开启TLS通信
+
+Saga 现在支持在omega和alpha服务之间采用 TLS 通信.同样客户端方面的认证（双向认证）。
+
+## 准备证书 （Certificates）
+
+你可以用下面的命令去生成一个用于测试的自签名的证书。
+如果你想采用双向认证的方式，只需要客户端证书。
+
+```
+# Changes these CN's to match your hosts in your environment if needed.
+SERVER_CN=localhost
+CLIENT_CN=localhost # Used when doing mutual TLS
+
+echo Generate CA key:
+openssl genrsa -passout pass:1111 -des3 -out ca.key 4096
+echo Generate CA certificate:
+# Generates ca.crt which is the trustCertCollectionFile
+openssl req -passin pass:1111 -new -x509 -days 365 -key ca.key -out ca.crt -subj "/CN=${SERVER_CN}"
+echo Generate server key:
+openssl genrsa -passout pass:1111 -des3 -out server.key 4096
+echo Generate server signing request:
+openssl req -passin pass:1111 -new -key server.key -out server.csr -subj "/CN=${SERVER_CN}"
+echo Self-signed server certificate:
+# Generates server.crt which is the certChainFile for the server
+openssl x509 -req -passin pass:1111 -days 365 -in server.csr -CA ca.crt -CAkey ca.key -set_serial 01 -out server.crt
+echo Remove passphrase from server key:
+openssl rsa -passin pass:1111 -in server.key -out server.key
+echo Generate client key
+openssl genrsa -passout pass:1111 -des3 -out client.key 4096
+echo Generate client signing request:
+openssl req -passin pass:1111 -new -key client.key -out client.csr -subj "/CN=${CLIENT_CN}"
+echo Self-signed client certificate:
+# Generates client.crt which is the clientCertChainFile for the client (need for mutual TLS only)
+openssl x509 -passin pass:1111 -req -days 365 -in client.csr -CA ca.crt -CAkey ca.key -set_serial 01 -out client.crt
+echo Remove passphrase from client key:
+openssl rsa -passin pass:1111 -in client.key -out client.key
+echo Converting the private keys to X.509:
+# Generates client.pem which is the clientPrivateKeyFile for the Client (needed for mutual TLS only)
+openssl pkcs8 -topk8 -nocrypt -in client.key -out client.pem
+# Generates server.pem which is the privateKeyFile for the Server
+openssl pkcs8 -topk8 -nocrypt -in server.key -out server.pem
+```
+
+## TLS为Alpha服务开启TLS
+
+1.为alpha-server修改application.yaml文件，在`alpha.server`部门增加ssl配置。
+```
+alpha:
+ server:
+ ssl:
+ enable: true
+ cert: server.crt
+ key: server.pem
+ mutualAuth: true
+ clientCert: client.crt
+```
+
+2. 将server.crt 和 server.pem 文件放到alpha-server的root 目录。如果你想双向认证，合并所有client证书到一个client.crt文件,并把client.crt文件放到root目录.
+
+3. 重新启动alpha服务器.
+
+
+## 为Omega启用TLS
+
+1. 获取CA证书串(chain), 如果你是将alpha服务运行在集群中，你可能需要去合并多个CA证书到一个文件中.
+
+2. 为客户端应用修改application.yaml文件, 在`alpha.cluster` 部分增加ssl配置.
+
+```
+alpha:
+ cluster:
+ address: alpha-server.servicecomb.io:8080
+ ssl:
+ enable: false
+ certChain: ca.crt
+ mutualAuth: false
+ cert: client.crt
+ key: client.pem
+```
+3. 把ca.crt文件放到客户端应用程序的root目录 file under the client application root directory.如果你想用双向认证，仍需要把client.crt和client.pem放到root目录下.
+
+4. 重新启动客户端应用程序.
+
diff --git a/saga-reference/zh_CN/faq/how_to_use_mysql_as_alpha_backend_database_zh.md b/saga-reference/zh_CN/faq/how_to_use_mysql_as_alpha_backend_database_zh.md
new file mode 100644
index 0000000..66b2ab7
--- /dev/null
+++ b/saga-reference/zh_CN/faq/how_to_use_mysql_as_alpha_backend_database_zh.md
@@ -0,0 +1,42 @@
+**问题描述:** 如何使用MySQL作为alpha的后台数据库？
+
+**解决方法:** 使用MySQL来替换默认的数据库PostgreSQL，只需以下两步：
+1. 在`alpha/alpha-server/pom.xml`添加`mysql-connector-java`的依赖：
+ ```xml
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ </dependency>
+ ```
+
+2. 安装Saga
+ ```bash
+ mvn clean package -Pdocker -DskipTests
+ ```
+ 在命令执行完成后，会生成名为alpha-server的镜像和可执行文件`alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`。
+
+ **注意**: 如果不需要生成docker镜像，则直接运行`mvn clean package -DskipTests`即可。
+
+ **注意**: 如果您之前已生成了alpha-server的docker镜像，则需要先执行以下命令将其删除：
+ ```bash
+ docker rmi -f $(docker images | grep alpha-server | awk '{print $3}')
+ ```
+
+3. 运行MySQL
+ ```bash
+ docker run -d -e "MYSQL_ROOT_PASSWORD=password" -e "MYSQL_DATABASE=saga" -e "MYSQL_USER=saga" -e "MYSQL_PASSWORD=password" -p 3306:3306 mysql/mysql-server:5.7
+ ```
+
+4. 运行alpha。请确保MySQL在此前已成功启动。alpha的运行可通过docker或可执行文件的方式。
+ * 通过docker
+ ```bash
+ docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=mysql -Dspring.datasource.url=jdbc:mysql://${host_address}:3306/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * 通过可执行文件
+ ```bash
+ java -Dspring.profiles.active=mysql -D"spring.datasource.url=jdbc:mysql://${host_address}:3306/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+ **注意**: 请在运行命令前将`${saga_version}`和`${host_address}`更改为实际值。
+
+ **注意**: 默认情况下，8080端口用于处理omega处发起的gRPC的请求，而8090端口用于处理查询存储在alpha处的事件信息。
+
diff --git a/saga-reference/zh_CN/static_files/exception_scenario.png b/saga-reference/zh_CN/static_files/exception_scenario.png
new file mode 100644
index 0000000..a8738ba
Binary files /dev/null and b/saga-reference/zh_CN/static_files/exception_scenario.png differ
diff --git a/saga-reference/zh_CN/static_files/exception_scenario_TCC.png b/saga-reference/zh_CN/static_files/exception_scenario_TCC.png
new file mode 100644
index 0000000..4753558
Binary files /dev/null and b/saga-reference/zh_CN/static_files/exception_scenario_TCC.png differ
diff --git a/saga-reference/zh_CN/static_files/inter-service_communication.png b/saga-reference/zh_CN/static_files/inter-service_communication.png
new file mode 100644
index 0000000..11d8dff
Binary files /dev/null and b/saga-reference/zh_CN/static_files/inter-service_communication.png differ
diff --git a/saga-reference/zh_CN/static_files/omega_internal.png b/saga-reference/zh_CN/static_files/omega_internal.png
new file mode 100644
index 0000000..1f130a2
Binary files /dev/null and b/saga-reference/zh_CN/static_files/omega_internal.png differ
diff --git a/saga-reference/zh_CN/static_files/pack.png b/saga-reference/zh_CN/static_files/pack.png
new file mode 100644
index 0000000..2c30c00
Binary files /dev/null and b/saga-reference/zh_CN/static_files/pack.png differ
diff --git a/saga-reference/zh_CN/static_files/saga.png b/saga-reference/zh_CN/static_files/saga.png
new file mode 100755
index 0000000..39460c3
Binary files /dev/null and b/saga-reference/zh_CN/static_files/saga.png differ
diff --git a/saga-reference/zh_CN/static_files/successful_scenario.png b/saga-reference/zh_CN/static_files/successful_scenario.png
new file mode 100644
index 0000000..5dd8850
Binary files /dev/null and b/saga-reference/zh_CN/static_files/successful_scenario.png differ
diff --git a/saga-reference/zh_CN/static_files/successful_scenario_TCC.png b/saga-reference/zh_CN/static_files/successful_scenario_TCC.png
new file mode 100644
index 0000000..dc44f35
Binary files /dev/null and b/saga-reference/zh_CN/static_files/successful_scenario_TCC.png differ
diff --git a/saga-reference/zh_CN/static_files/timeout_scenario.png b/saga-reference/zh_CN/static_files/timeout_scenario.png
new file mode 100644
index 0000000..998cfcf
Binary files /dev/null and b/saga-reference/zh_CN/static_files/timeout_scenario.png differ
diff --git a/saga-reference/zh_CN/user_guide_zh.md b/saga-reference/zh_CN/user_guide_zh.md
new file mode 100644
index 0000000..5e156a9
--- /dev/null
+++ b/saga-reference/zh_CN/user_guide_zh.md
@@ -0,0 +1,136 @@
+# Saga 用户指南
+[](user_guide.md)
+
+## 准备环境
+1. 安装[JDK 1.8][jdk]
+2. 安装[Maven 3.x][maven]
+3. 安装[Docker][docker]
+
+[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+[maven]: https://maven.apache.org/install.html
+[docker]: https://www.docker.com/get-docker
+
+## 编译
+
+获取源码：
+```bash
+$ git clone https://github.com/apache/incubator-servicecomb-saga.git
+$ cd incubator-servicecomb-saga
+```
+
+Saga可通过以下任一方式进行构建：
+* 只构建可执行文件：
+ ```bash
+ $ mvn clean install -DskipTests
+ ```
+
+* 同时构建可执行文件和docker镜像：
+ ```bash
+ $ mvn clean install -DskipTests -Pdocker
+ ```
+
+* 同时构建可执行文件以及Saga发行包
+ ```bash
+ $ mvn clean install -DskipTests -Prelease
+ ```
+
+
+在执行以上任一指令后，可在`alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`中找到alpha server的可执行文件。
+
+## 如何使用
+### 引入Saga的依赖
+```xml
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-spring-starter</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.servicecomb.saga</groupId>
+ <artifactId>omega-transport-resttemplate</artifactId>
+ <version>${saga.version}</version>
+ </dependency>
+```
+**注意**: 请将`${saga.version}`更改为实际的版本号。
+
+### 添加Saga的注解及相应的补偿方法
+以一个转账应用为例：
+1. 在应用入口添加 `@EnableOmega` 的注解来初始化omega的配置并与alpha建立连接。
+ ```java
+ @SpringBootApplication
+ @EnableOmega
+ public class Application {
+ public static void main(String[] args) {
+ SpringApplication.run(Application.class, args);
+ }
+ }
+ ```
+
+2. 在全局事务的起点添加 `@SagaStart` 的注解。
+ ```java
+ @SagaStart(timeout=10)
+ public boolean transferMoney(String from, String to, int amount) {
+ transferOut(from, amount);
+ transferIn(to, amount);
+ }
+ ```
+ **注意:** 默认情况下，超时设置需要显式声明才生效。
+
+3. 在子事务处添加 `@Compensable` 的注解并指明其对应的补偿方法。
+ ```java
+ @Compensable(timeout=5, compensationMethod="cancel")
+ public boolean transferOut(String from, int amount) {
+ repo.reduceBalanceByUsername(from, amount);
+ }
+
+ public boolean cancel(String from, int amount) {
+ repo.addBalanceByUsername(from, amount);
+ }
+ ```
+
+ **注意:** 实现的服务和补偿必须满足幂等的条件。
+
+ **注意:** 默认情况下，超时设置需要显式声明才生效。
+
+ **注意:** 若全局事务起点与子事务起点重合，需同时声明 `@SagaStart` 和 `@Compensable` 的注解。
+
+4. 对转入服务重复第三步即可。
+
+5. 从Saga-0.3.0, 你可以在服务函数或者取消函数中通过访问 [OmegaContext](https://github.com/apache/incubator-servicecomb-saga/blob/master/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java) 来获取 gloableTxId 以及 localTxId 信息。
+
+
+## 如何运行
+1. 运行postgreSQL,
+ ```bash
+ docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
+ ```
+ 如果你想使用MySQL做为后台数据库，可以参考 [此文档](https://github.com/apache/incubator-servicecomb-saga/blob/master/docs/faq/en/how_to_use_mysql_as_alpha_backend_database.md)。
+
+
+2. 运行alpha。在运行alpha前，请确保postgreSQL已正常启动。可通过docker或可执行文件的方式来启动alpha。
+ * 通过docker运行：
+ ```bash
+ docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * 通过可执行文件运行：
+ ```bash
+ java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+
+ **注意**: 请在执行命令前将`${saga_version}`和`${host_address}`更改为实际值。
+
+
+ **注意**: 默认情况下，8080端口用于处理omega处发起的gRPC的请求，而8090端口用于处理查询存储在alpha处的事件信息。
+
+
+3. 配置omega。在 `application.yaml` 添加下面的配置项：
+ ```yaml
+ spring:
+ application:
+ name: {application.name}
+ alpha:
+ cluster:
+ address: {alpha.cluster.addresses}
+ ```
+
+然后就可以运行相关的微服务了，可通过访问http://${alpha-server:port}/events 来获取所有的saga事件信息。
diff --git a/service-center-reference/LANGS.md b/service-center-reference/LANGS.md
new file mode 100644
index 0000000..4106f21
--- /dev/null
+++ b/service-center-reference/LANGS.md
@@ -0,0 +1,2 @@
+* [英文](en_US/)
+* [中文](zh_CN/)
\ No newline at end of file
diff --git a/service-center-reference/book.json b/service-center-reference/book.json
new file mode 100644
index 0000000..30c4ecc
--- /dev/null
+++ b/service-center-reference/book.json
@@ -0,0 +1,5 @@
+{
+ "structure": {
+ "readme": "design.md"
+ }
+}
\ No newline at end of file
diff --git a/service-center-reference/en_US/README.md b/service-center-reference/en_US/README.md
new file mode 100644
index 0000000..eb144af
--- /dev/null
+++ b/service-center-reference/en_US/README.md
@@ -0,0 +1,33 @@
+## Documentation Index
+
+#### [Design](/docs/design.md)
+
+#### [Development Guide](/docs/dev-guide.md)
+
+- [Api Documentation](https://rawcdn.githack.com/ServiceComb/service-center/master/docs/api-docs.html)
+
+- [Plug-in Extension](/server/plugin/README.md)
+
+#### [Docker Image Guide](/scripts/docker)
+
+- [Making Service-Center Image](/scripts/docker/build-image)
+
+- [Making Front-end Image](/scripts/docker/build-frontend-image)
+
+#### Deploy Service-Center Locally
+
+- [In Docker](/integration/docker)
+
+#### Deploy Service-Center Cluster
+
+- [In Kubernetes Cluster](/integration/k8s)
+
+- [In VM](/docs/sc-cluster.md)
+
+- [Deploy with TLS](/docs/security-tls.md)
+
+#### Monitoring Service-Center
+
+- [Integrate with Grafana](/docs/integration-grafana.md)
+
+#### [Contribution Guide](/docs/contribution.md)
\ No newline at end of file
diff --git a/service-center-reference/en_US/SUMMARY.md b/service-center-reference/en_US/SUMMARY.md
new file mode 100644
index 0000000..b1631df
--- /dev/null
+++ b/service-center-reference/en_US/SUMMARY.md
@@ -0,0 +1,83 @@
+# 目录
+
+* [概述](introduction.md)
+* [入门](catalog/start.md)
+ * [术语表](start/terminology.md)
+ * [微服务系统架构](start/architecture.md)
+ * [安装本地开发环境](start/development-environment.md)
+ * [开发第一个微服务](start/first-sample.md)
+* [开发服务提供者](catalog/build-provider.md)
+ * [服务定义](build-provider/definition/service-definition.md)
+ * [定义服务契约](build-provider/define-contract.md)
+ * [使用隐式契约](build-provider/code-first.md)
+ * [使用Swagger注解](build-provider/swagger-annotation.md)
+ * [用SpringMVC开发微服务](build-provider/springmvc.md)
+ * [用JAX-RS开发微服务](build-provider/jaxrs.md)
+ * [用透明RPC开发微服务](build-provider/transparent-rpc.md)
+ * [接口定义和数据类型](build-provider/interface-constraints.md)
+ * [服务监听地址和发布地址](build-provider/listen-address-and-publish-address.md)
+ * [服务配置](build-provider/service-configuration.md)
+ * [负载均衡策略](build-provider/configuration/lb-strategy.md)
+ * [限流策略](build-provider/configuration/ratelimite-strategy.md)
+ * [降级策略](build-provider/configuration/downgrade-strategy.md)
+ * [参数效验](build-provider/configuration/parameter-validator.md)
+ * [通信协议](build-provider/protocol.md)
+ * [线程模型](build-provider/protocol/thread-model.md)
+ * [REST over Servlet](build-provider/protocol/rest-over-servlet.md)
+ * [REST over Vertx](build-provider/protocol/rest-over-vertx.md)
+ * [Highway RPC协议](build-provider/protocol/highway-rpc.md)
+ * [使用HTTP2通信](build-provider/protocol/http2.md)
+ * [程序启动逻辑](build-provider/bootup.md)
+ * [微服务实例之间的逻辑隔离关系](build-provider/definition/isolate-relationship.md)
+ * [Access Log配置](build-provider/access-log-configuration.md)
+* [开发服务消费者](catalog/build-consumer.md)
+ * [使用RestTemplate开发服务消费者](build-consumer/using-resttemplate.md)
+ * [使用AsynRestTemplate开发服务消费者](build-consumer/using-AsyncRestTemplate.md)
+ * [使用RPC方式开发服务消费者](build-consumer/develop-consumer-using-rpc.md)
+ * [使用服务契约](build-consumer/with-contract.md)
+ * [调用控制](build-consumer/invoke-control.md)
+ * [实例级故障隔离](build-consumer/instance-isolation.md)
+ * [熔断策略](build-consumer/circuit-breaker.md)
+ * [限流策略](build-consumer/flow-control.md)
+ * [故障注入](build-consumer/fault-injection.md)
+* [通用开发](catalog/general-develop.md)
+ * [访问服务中心](general-development/visit-sc.md)
+ * [使用动态配置](general-development/config.md)
+ * [应用性能监控](general-development/metrics.md)
+ * [微服务调用链](general-development/microservice-invocation-chain.md)
+ * [自定义调用链打点](general-development/customized-tracing.md)
+ * [本地开发和测试](general-development/local-develop-test.md)
+ * [Http Filter](general-development/http-filter.md)
+ * [文件上传](general-development/file-upload.md)
+ * [文件下载](general-development/file-download.md)
+ * [Reactive](general-development/reactive.md)
+ * [DNS自定义配置](general-development/dnsconfig.md)
+ * [代理设置](general-development/dai-li-she-zhi.md)
+ * [框架上报版本号](general-development/report-framework-version.md)
+ * [跨应用调用](general-development/cross-app-invocation.md)
+ * [定制序列化和反序列化方法](general-development/secret-field.md)
+ * [使用Context传递控制消息](general-development/context.md)
+ * [返回值序列化扩展](general-development/produceprocess.md)
+ * [CORS机制](general-development/CORS.md)
+ * [获取熔断与实例隔离告警事件信息](general-development/AlarmEvent.md)
+* [服务能力开放](edge/open-service.md)
+ * [使用Edge Service做边缘服务](edge/by-servicecomb-sdk.md)
+ * [使用confd和Nginx做边缘服务](edge/nginx.md)
+ * [使用zuul做边缘服务](edge/zuul.md)
+* [服务打包和运行](catalog/service-package-run.md)
+ * [以standalone模式打包](packaging/standalone.md)
+ * [以WEB容器模式打包](packaging/web-container.md)
+* [微服务安全](catalog/security.md)
+ * [使用TLS通信](security/tls.md)
+ * [使用RSA认证](security/shi-yong-rsa-ren-zheng.md)
+* [在Spring Boot中使用java chassis](using-java-chassis-in-spring-boot.md)
+ * [提供的组件说明](using-java-chassis-in-spring-boot/components-for-spring-boot.md)
+ * [JAVA应用方式开发步骤](using-java-chassis-in-spring-boot/java-application.md)
+ * [Web开发方式开发步骤](using-java-chassis-in-spring-boot/web-application.md)
+ * [JAVA应用方式和Web开发方式的区别](using-java-chassis-in-spring-boot/diff-between-java-web.md)
+ * [Spring MVC模式的差异](using-java-chassis-in-spring-boot/diff-spring-mvc.md)
+* [处理链参考](references-handlers/intruduction.md)
+ * [负载均衡](references-handlers/loadbalance.md)
+ * [公钥认证](references-handlers/publickey.md)
+* [常见问题](question-and-answer/question_answer.md)
+ * [微服务接口兼容常见问题](question-and-answer/interface-compatibility.md)
diff --git a/service-center-reference/en_US/api-docs.html b/service-center-reference/en_US/api-docs.html
new file mode 100644
index 0000000..3f221c5
--- /dev/null
+++ b/service-center-reference/en_US/api-docs.html
@@ -0,0 +1,3703 @@
+<!--
+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下线。 </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 </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 </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>
diff --git a/service-center-reference/en_US/contribution.md b/service-center-reference/en_US/contribution.md
new file mode 100644
index 0000000..60a904d
--- /dev/null
+++ b/service-center-reference/en_US/contribution.md
@@ -0,0 +1,50 @@
+## Contribution guide for Service-Center
+
+Thanks everyone for contributing to [Service-Center](https://github.com/apache/incubator-servicecomb-service-center).
+
+This document explains the process and best practices for submitting a Pull Request to the Service-Center project. This document can be treated as a reference for all contributors and be useful to new and infrequent submitters.
+
+#### Cloning the repo and put it in $GOPATH
+
+Clone the repo in a proper GOPATH
+
+```
+git clone https://github.com/apache/incubator-servicecomb-service-center.git $GOPATH/src/github.com/apache/incubator-servicecomb-service-center
+cd $GOPATH/src/github.com/apache/incubator-servicecomb-service-center
+```
+
+#### Download the Dependencies
+
+We use glide for dependency management, please follow the below steps for downloading all the dependencies required for building this project.
+
+```
+curl https://glide.sh/get | sh
+glide install
+```
+
+#### Make your Changes
+
+If this is a bug or a small fix then you can directly make the changes and ensure all the steps in this documentation and raise a PR, but If it is a feature or a big design or architecture change then we recommend you to raise an issue [here](https://github.com/apache/incubator-servicecomb-service-center/issues) or discuss the same in our [mailing list](https://groups.google.com/forum/#!forum/servicecomb-developers).
+
+#### Compile and running Test locally.
+
+Once you are done with your changes then please follow the below checks to ensure the code quality before raising a PR.
+```
+go fmt ./...
+
+go build -o service-center
+```
+
+Running UT in local env, this step assumes you have a docker running in your env.
+```
+bash -x scripts/ut_test_in_docker.sh
+```
+
+Once UT has passed you can run the integration test to ensure the overall functionality is not altered.
+```
+bash -x scripts/integration_test.sh
+```
+
+#### Pushing the Code and Raising PR
+
+Once you are done with compiling, UT and IT then you are good to go for raising the PR, please follow these [guidelines](https://help.github.com/articles/creating-a-pull-request/) for raising the PR.
diff --git a/service-center-reference/en_US/design.md b/service-center-reference/en_US/design.md
new file mode 100644
index 0000000..12c73f6
--- /dev/null
+++ b/service-center-reference/en_US/design.md
@@ -0,0 +1,26 @@
+## Service-Center Design
+
+Service-Center(SC) is a service registry that allows services to register their instance information and to discover providers of a given service.
+SC uses etcd to store all the information of micro-service and its instances. Below is the diagram stating the working principles and flow of SC.
+
+#### On StartUp
+Here we assume that micro-services are written using [java-chassis](https://github.com/ServiceComb/java-chassis) sdk. So when micro-service boots up then java-chassis sdk does the following list of tasks.
+
+1. On startup provider registers the micro-service to SC if not registered earlier and also register its instance information like its Ip and Port on which instance is running.
+2. SC stores the provider information in etcd.
+3. On startup consumer retrieves the list of all provider instance from SC using the micro-service name of the provider.
+4. Consumer sdk stores all the information of provider instances in its cache.
+5. Consumer sdk creates a web socket connection to SC to watch all the provider instance information, if there is any change in the provider then sdk updates it's cache information.
+
+
+
+#### Communication between Consumer -> Provider
+Once the bootup is successful then the consumer can communicate with providers flawlessly, below is the diagram illustrating the communication between provider and consumer.
+
+
+
+Provider instance regularly sends heartbeat signal every 30 seconds to SC, if SC does not receive the heartbeat for particular instance then the information in etcd expires and the provider instance information is removed.
+Consumer watches the information of provider instances from SC and if there is any change then the cache is updated.
+When Consumer needs to communicate to Provider then consumer reads endpoints of the provider instances from cache and do loadbalancing to communicate to Provider.
+
+Note: This document is in beta stage, feel free to contribute to this document.
diff --git a/service-center-reference/en_US/dev-guide.md b/service-center-reference/en_US/dev-guide.md
new file mode 100644
index 0000000..98f3527
--- /dev/null
+++ b/service-center-reference/en_US/dev-guide.md
@@ -0,0 +1,97 @@
+# Development Guide
+
+This chapter is about how to implement the feature of micro-service discovery with ServiceCenter,
+and you can get more detail at [here](/server/core/swagger/v3.yaml)
+
+## Micro-service registration
+```bash
+curl -X POST \
+ http://127.0.0.1:30100/registry/v3/microservices \
+ -H 'content-type: application/json' \
+ -H 'x-domain-name: default' \
+ -d '{
+ "service":
+ {
+ "appId": "default",
+ "serviceName": "DemoService",
+ "version":"1.0.0"
+ }
+}'
+```
+
+and then you can get the 'DemoService' ID like below:
+
+```json
+{
+ "serviceId": "a3fae679211211e8a831286ed488fc1b"
+}
+```
+
+## Instance registration
+
+mark down the micro-service ID and call the instance registration API,
+according to the ServiceCenter definition: One process should be registered as one instance
+
+```bash
+curl -X POST \
+ http://127.0.0.1:30100/registry/v3/microservices/a3fae679211211e8a831286ed488fc1b/instances \
+ -H 'content-type: application/json' \
+ -H 'x-domain-name: default' \
+ -d '{
+ "instance":
+ {
+ "hostName":"demo-pc",
+ "endpoints": [
+ "rest://127.0.0.1:8080"
+ ]
+ }
+}'
+```
+
+the successful response like below:
+
+```json
+{
+ "instanceId": "288ad703211311e8a831286ed488fc1b"
+}
+```
+
+if all are successful, it means you have completed the micro-service registration and instance publish
+
+## Discovery
+
+the next step is that discovery the micro-service instance by service name and version rule
+
+```bash
+curl -X GET \
+ 'http://127.0.0.1:30100/registry/v3/instances?appId=default&serviceName=DemoService&version=latest' \
+ -H 'content-type: application/json' \
+ -H 'x-consumerid: a3fae679211211e8a831286ed488fc1b' \
+ -H 'x-domain-name: default'
+```
+
+here, you can get the information from the response
+
+```json
+{
+ "instances": [
+ {
+ "instanceId": "b4c9e57f211311e8a831286ed488fc1b",
+ "serviceId": "a3fae679211211e8a831286ed488fc1b",
+ "version": "1.0.0",
+ "hostName": "demo-pc",
+ "endpoints": [
+ "rest://127.0.0.1:8080"
+ ],
+ "status": "UP",
+ "healthCheck": {
+ "mode": "push",
+ "interval": 30,
+ "times": 3
+ },
+ "timestamp": "1520322915",
+ "modTimestamp": "1520322915"
+ }
+ ]
+}
+```
\ No newline at end of file
diff --git a/service-center-reference/en_US/integration-grafana.md b/service-center-reference/en_US/integration-grafana.md
new file mode 100644
index 0000000..1909fd8
--- /dev/null
+++ b/service-center-reference/en_US/integration-grafana.md
@@ -0,0 +1,9 @@
+# Integrate with Grafana
+
+As Service-Center uses Prometheus lib to report metrics.
+Then it is easy to integrate with Grafana.
+Here is a [template](/integration/health-metrics-grafana.json) file can be imported in Grafana.
+
+After the import, you can get the view like blow.
+
+
\ No newline at end of file
diff --git a/service-center-reference/en_US/pr-raising-guide.md b/service-center-reference/en_US/pr-raising-guide.md
new file mode 100644
index 0000000..30d8d3e
--- /dev/null
+++ b/service-center-reference/en_US/pr-raising-guide.md
@@ -0,0 +1,24 @@
+### PR raising Guide
+
+If you want to raise a PR in this repo then you can follow the below guidelines to avoid conflicts.
+
+1. Make your changes in your local code.
+2. Once your changes are done the clone the code from ServiceComb
+```
+git clone http://github.com/apache/incubator-servicecomb-service-center.git
+cd service-center
+git remote add fork http://github.com/{YOURFORKNAME}/service-center.git
+git checkout -b {YOURFEATURENAME}
+
+#Merge your local changes in this branch.
+
+#Once your changes are done then Push the changes to your fork
+
+git add -A
+
+git commit -m "{JIRA-ID YOURCOMMITMESSAGE}"
+
+git push fork {YOURFEATURENAME}
+```
+3. Now go to github and browse to your branch and raise a PR from that branch.
+
diff --git a/service-center-reference/en_US/release/Readme.md b/service-center-reference/en_US/release/Readme.md
new file mode 100644
index 0000000..994ef74
--- /dev/null
+++ b/service-center-reference/en_US/release/Readme.md
@@ -0,0 +1,42 @@
+## Service-Center Release
+
+#### Release Notes
+ - [Service-Center-1.0.0-m1 Release Notes](/docs/release/releaseNotes-1.0.0-m1.md)
+ - [Service-Center-1.0.0-m2 Release Notes](/docs/release/releaseNotes-1.0.0-m2.md)
+
+
+#### Running Apache Rat tool
+This guide will help you to run the [Apache Rat](http://creadur.apache.org/rat/index.html) tool on service-center source code.
+For running the tool please follow the below guidelines.
+
+##### Step 1
+Clone the Servcice-Center code and download Apache Rat tool.
+```
+git clone https://github.com/apache/incubator-servicecomb-service-center
+```
+
+```
+wget http://mirrors.hust.edu.cn/apache//creadur/apache-rat-0.12/apache-rat-0.12-bin.tar.gz
+
+# Untar the release
+tar -xvf apache-rat-0.12-bin.tar.gz
+
+# Copy the jar in the root directory
+cp apache-rat-0.12/apache-rat-0.12.jar ./
+```
+##### Step 2
+Run the Rat tool using the below command
+
+```
+java -jar apache-rat-0.12.jar -a -d incubator-servicecomb-service-center/ -e *.md *.MD .gitignore .gitmodules .travis.yml manifest **vendor** **licenses** bower.json
+```
+
+Below is the list of the files which has been excluded from the list of RAT tool.
+ - *.md *.MD *.html: Skip all the Readme and Documentation file like Api Docs.
+ - .gitignore .gitmodules .travis.yml : Skip the git files and travis file.
+ - manifest **vendor : Skip manifest and all the files under vendor.
+ - bower.json : Skip bower installation file
+
+You can access the latest RAT report [here](/docs/release/rat-report)
+
+
diff --git a/service-center-reference/en_US/release/rat-report/Rat-Report-2018-02-23.md b/service-center-reference/en_US/release/rat-report/Rat-Report-2018-02-23.md
new file mode 100644
index 0000000..7bc6aae
--- /dev/null
+++ b/service-center-reference/en_US/release/rat-report/Rat-Report-2018-02-23.md
@@ -0,0 +1,266 @@
+```
+*****************************************************
+Summary
+-------
+Generated at: 2018-02-23T19:40:21+08:00
+
+Notes: 3
+Binaries: 9
+Archives: 0
+Standards: 227
+
+Apache Licensed: 227
+Generated Documents: 0
+
+JavaDocs are generated, thus a license header is optional.
+Generated files do not require license headers.
+
+0 Unknown Licenses
+
+*****************************************************
+ Files with Apache License headers will be marked AL
+ Binary files (which do not require any license headers) will be marked B
+ Compressed archives will be marked A
+ Notices, licenses etc. will be marked N
+ N incubator-servicecomb-service-center/DISCLAIMER
+ N incubator-servicecomb-service-center/LICENSE
+ N incubator-servicecomb-service-center/NOTICE
+ AL incubator-servicecomb-service-center/main.go
+ B incubator-servicecomb-service-center/docs/Service-Center-UI-Preview.gif
+ B incubator-servicecomb-service-center/docs/communication.PNG
+ B incubator-servicecomb-service-center/docs/onStartup.PNG
+ B incubator-servicecomb-service-center/docs/tracing-file.PNG
+ B incubator-servicecomb-service-center/docs/tracing-server.PNG
+ AL incubator-servicecomb-service-center/examples/service_center/request/add_dependecy.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/create_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/delete_instance.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/delete_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_consumers.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_providers.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/heartbeat.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/register_intance_json.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/update_properties.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/update_status.sh
+ AL incubator-servicecomb-service-center/frontend/main.go
+ B incubator-servicecomb-service-center/frontend/app/favicon.ico
+ AL incubator-servicecomb-service-center/frontend/app/apiList/apiList.js
+ B incubator-servicecomb-service-center/frontend/app/images/loader.gif
+ B incubator-servicecomb-service-center/frontend/app/images/sc.png
+ B incubator-servicecomb-service-center/frontend/app/images/yeoman.png
+ AL incubator-servicecomb-service-center/frontend/app/scripts/app.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/scRouterConfig.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/controllers/serviceCenterCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/directives/nodataFoundDirective.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/directives/tableDirective.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-cz.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-en.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/dashboard/controllers/dashboardCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/schemaCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/serviceInfoCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/servicesListCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/filters/formatSchema.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/services/commonService.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/services/httpService.js
+ AL incubator-servicecomb-service-center/frontend/app/styles/main.css
+ AL incubator-servicecomb-service-center/frontend/schema/schemahandler.go
+ AL incubator-servicecomb-service-center/integration/apis.go
+ AL incubator-servicecomb-service-center/integration/governance_test.go
+ AL incubator-servicecomb-service-center/integration/health_test.go
+ AL incubator-servicecomb-service-center/integration/instances_test.go
+ AL incubator-servicecomb-service-center/integration/integrationtest_suite_test.go
+ AL incubator-servicecomb-service-center/integration/microservices_test.go
+ AL incubator-servicecomb-service-center/integration/rules_test.go
+ AL incubator-servicecomb-service-center/integration/schema_test.go
+ AL incubator-servicecomb-service-center/integration/tags_test.go
+ AL incubator-servicecomb-service-center/pkg/async/async_task.go
+ AL incubator-servicecomb-service-center/pkg/async/async_task_test.go
+ AL incubator-servicecomb-service-center/pkg/chain/callback.go
+ AL incubator-servicecomb-service-center/pkg/chain/chain.go
+ AL incubator-servicecomb-service-center/pkg/chain/chain_test.go
+ AL incubator-servicecomb-service-center/pkg/chain/handler.go
+ AL incubator-servicecomb-service-center/pkg/chain/invocation.go
+ AL incubator-servicecomb-service-center/pkg/errors/error.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/etcdsync_suite_test.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/mutex.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/mutex_test.go
+ AL incubator-servicecomb-service-center/pkg/grace/grace.go
+ AL incubator-servicecomb-service-center/pkg/plugin/loader.go
+ AL incubator-servicecomb-service-center/pkg/plugin/loader_test.go
+ AL incubator-servicecomb-service-center/pkg/rest/client.go
+ AL incubator-servicecomb-service-center/pkg/rest/common.go
+ AL incubator-servicecomb-service-center/pkg/rest/conn.go
+ AL incubator-servicecomb-service-center/pkg/rest/listener.go
+ AL incubator-servicecomb-service-center/pkg/rest/roa.go
+ AL incubator-servicecomb-service-center/pkg/rest/route.go
+ AL incubator-servicecomb-service-center/pkg/rest/server.go
+ AL incubator-servicecomb-service-center/pkg/rpc/grpc.go
+ AL incubator-servicecomb-service-center/pkg/tlsutil/tlsutil.go
+ AL incubator-servicecomb-service-center/pkg/util/concurrent_map.go
+ AL incubator-servicecomb-service-center/pkg/util/concurrent_map_test.go
+ AL incubator-servicecomb-service-center/pkg/util/context.go
+ AL incubator-servicecomb-service-center/pkg/util/goroutines.go
+ AL incubator-servicecomb-service-center/pkg/util/goroutines_test.go
+ AL incubator-servicecomb-service-center/pkg/util/log.go
+ AL incubator-servicecomb-service-center/pkg/util/log_test.go
+ AL incubator-servicecomb-service-center/pkg/util/logrotate.go
+ AL incubator-servicecomb-service-center/pkg/util/metric.go
+ AL incubator-servicecomb-service-center/pkg/util/net.go
+ AL incubator-servicecomb-service-center/pkg/util/net_test.go
+ AL incubator-servicecomb-service-center/pkg/util/reflect.go
+ AL incubator-servicecomb-service-center/pkg/util/reflect_test.go
+ AL incubator-servicecomb-service-center/pkg/util/sys.go
+ AL incubator-servicecomb-service-center/pkg/util/tree.go
+ AL incubator-servicecomb-service-center/pkg/util/tree_test.go
+ AL incubator-servicecomb-service-center/pkg/util/uniqueue.go
+ AL incubator-servicecomb-service-center/pkg/util/uniqueue_test.go
+ AL incubator-servicecomb-service-center/pkg/util/util.go
+ AL incubator-servicecomb-service-center/pkg/util/util_test.go
+ AL incubator-servicecomb-service-center/pkg/util/uuid.go
+ AL incubator-servicecomb-service-center/pkg/validate/url.go
+ AL incubator-servicecomb-service-center/pkg/validate/validate.go
+ AL incubator-servicecomb-service-center/scripts/create_gvt_manifest(exp).sh
+ AL incubator-servicecomb-service-center/scripts/integration_test.sh
+ AL incubator-servicecomb-service-center/scripts/prepare_env_ut.sh
+ AL incubator-servicecomb-service-center/scripts/ut.sh
+ AL incubator-servicecomb-service-center/scripts/ut_test_in_docker.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-frontend-image/build.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-image/build.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-image/start.sh
+ AL incubator-servicecomb-service-center/scripts/frontend/start_linux.sh
+ AL incubator-servicecomb-service-center/scripts/frontend/start_windows.bat
+ AL incubator-servicecomb-service-center/scripts/release/make_frontend_release.sh
+ AL incubator-servicecomb-service-center/scripts/release/make_release.sh
+ AL incubator-servicecomb-service-center/server/api.go
+ AL incubator-servicecomb-service-center/server/server.go
+ AL incubator-servicecomb-service-center/server/bootstrap/bootstrap.go
+ AL incubator-servicecomb-service-center/server/core/0_init.go
+ AL incubator-servicecomb-service-center/server/core/common.go
+ AL incubator-servicecomb-service-center/server/core/info.go
+ AL incubator-servicecomb-service-center/server/core/key_generator.go
+ AL incubator-servicecomb-service-center/server/core/microservice.go
+ AL incubator-servicecomb-service-center/server/core/backend/backend.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/async.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/cacher.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/defer.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/defer_test.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/event.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/indexer.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/lease.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/listwatch.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/opt.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/store.go
+ AL incubator-servicecomb-service-center/server/core/proto/services.go
+ AL incubator-servicecomb-service-center/server/error/error.go
+ AL incubator-servicecomb-service-center/server/govern/controller_v3.go
+ AL incubator-servicecomb-service-center/server/govern/controller_v4.go
+ AL incubator-servicecomb-service-center/server/govern/govern.go
+ AL incubator-servicecomb-service-center/server/govern/govern_suite_test.go
+ AL incubator-servicecomb-service-center/server/govern/service.go
+ AL incubator-servicecomb-service-center/server/govern/service_test.go
+ AL incubator-servicecomb-service-center/server/handler/auth/auth.go
+ AL incubator-servicecomb-service-center/server/handler/cache/cache.go
+ AL incubator-servicecomb-service-center/server/handler/context/context.go
+ AL incubator-servicecomb-service-center/server/handler/context/v3.go
+ AL incubator-servicecomb-service-center/server/handler/context/v4.go
+ AL incubator-servicecomb-service-center/server/handler/metric/metric.go
+ AL incubator-servicecomb-service-center/server/handler/tracing/tracing.go
+ AL incubator-servicecomb-service-center/server/infra/auditlog/auditlog.go
+ AL incubator-servicecomb-service-center/server/infra/auth/auth.go
+ AL incubator-servicecomb-service-center/server/infra/quota/quota.go
+ AL incubator-servicecomb-service-center/server/infra/registry/registry.go
+ AL incubator-servicecomb-service-center/server/infra/security/cipher.go
+ AL incubator-servicecomb-service-center/server/infra/tracing/tracing.go
+ AL incubator-servicecomb-service-center/server/infra/uuid/uuid.go
+ AL incubator-servicecomb-service-center/server/interceptor/interceptors.go
+ AL incubator-servicecomb-service-center/server/interceptor/access/access.go
+ AL incubator-servicecomb-service-center/server/interceptor/cors/cors.go
+ AL incubator-servicecomb-service-center/server/mux/mux.go
+ AL incubator-servicecomb-service-center/server/plugin/plugin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/auth/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/quota/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/quota/unlimit/unlimit.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/embededetcd/embededetcd.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/etcd.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/tracing.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/security/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/common.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/file_collector.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span_test.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/uuid/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/rest/handler.go
+ AL incubator-servicecomb-service-center/server/rest/metric.go
+ AL incubator-servicecomb-service-center/server/rest/server.go
+ AL incubator-servicecomb-service-center/server/rest/controller/rest_util.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/dependency_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_watcher.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/main_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/microservice_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/query_rule_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/schema_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/tag_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/v3.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/dependency_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_watcher.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/main_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/microservice_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/query_rule_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/schema_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/tag_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/v4.go
+ AL incubator-servicecomb-service-center/server/rpc/server.go
+ AL incubator-servicecomb-service-center/server/service/concurrent_test.go
+ AL incubator-servicecomb-service-center/server/service/instances.go
+ AL incubator-servicecomb-service-center/server/service/instances_test.go
+ AL incubator-servicecomb-service-center/server/service/microservices.go
+ AL incubator-servicecomb-service-center/server/service/microservices_test.go
+ AL incubator-servicecomb-service-center/server/service/resource_assembler.go
+ AL incubator-servicecomb-service-center/server/service/rule.go
+ AL incubator-servicecomb-service-center/server/service/rule_test.go
+ AL incubator-servicecomb-service-center/server/service/schema.go
+ AL incubator-servicecomb-service-center/server/service/schema_test.go
+ AL incubator-servicecomb-service-center/server/service/service_dependency.go
+ AL incubator-servicecomb-service-center/server/service/service_dependency_test.go
+ AL incubator-servicecomb-service-center/server/service/service_suite_test.go
+ AL incubator-servicecomb-service-center/server/service/tag.go
+ AL incubator-servicecomb-service-center/server/service/tag_test.go
+ AL incubator-servicecomb-service-center/server/service/event/dependency_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/event.go
+ AL incubator-servicecomb-service-center/server/service/event/instance_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/rule_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/service_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/tag_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/notification/listwatcher.go
+ AL incubator-servicecomb-service-center/server/service/notification/notification_healthchecker.go
+ AL incubator-servicecomb-service-center/server/service/notification/notification_service.go
+ AL incubator-servicecomb-service-center/server/service/notification/struct.go
+ AL incubator-servicecomb-service-center/server/service/notification/watch_util.go
+ AL incubator-servicecomb-service-center/server/service/util/dependency.go
+ AL incubator-servicecomb-service-center/server/service/util/dependency_test.go
+ AL incubator-servicecomb-service-center/server/service/util/domain_util.go
+ AL incubator-servicecomb-service-center/server/service/util/domain_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/heartbeat_util.go
+ AL incubator-servicecomb-service-center/server/service/util/heartbeat_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/instance_util.go
+ AL incubator-servicecomb-service-center/server/service/util/instance_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/microservice_util.go
+ AL incubator-servicecomb-service-center/server/service/util/rule_util.go
+ AL incubator-servicecomb-service-center/server/service/util/rule_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/schema_util.go
+ AL incubator-servicecomb-service-center/server/service/util/schema_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/tag_util.go
+ AL incubator-servicecomb-service-center/server/service/util/tag_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/util.go
+ AL incubator-servicecomb-service-center/server/service/util/util_suite_test.go
+ AL incubator-servicecomb-service-center/server/service/util/versionrule.go
+ AL incubator-servicecomb-service-center/server/service/util/versionrule_test.go
+ AL incubator-servicecomb-service-center/server/tls/tls.go
+ AL incubator-servicecomb-service-center/version/version.go
+
+*****************************************************
+```
\ No newline at end of file
diff --git a/service-center-reference/en_US/release/rat-report/Rat-Report-2018-03-08.md b/service-center-reference/en_US/release/rat-report/Rat-Report-2018-03-08.md
new file mode 100644
index 0000000..d26e69f
--- /dev/null
+++ b/service-center-reference/en_US/release/rat-report/Rat-Report-2018-03-08.md
@@ -0,0 +1,280 @@
+```
+root@SZX1000272432:~/apache# java -jar apache-rat-0.12.jar -a -d incubator-servicecomb-service-center/ -e *.md *.MD .gitignore .gitmodules .travis.yml *.json *.yaml *.tmpl *.conf *.html *.pb.go services.proto broker.proto manifest **vendor** **licenses**
+
+*****************************************************
+Summary
+-------
+Generated at: 2018-03-08T16:38:30+08:00
+
+Notes: 5
+Binaries: 9
+Archives: 0
+Standards: 237
+
+Apache Licensed: 237
+Generated Documents: 0
+
+JavaDocs are generated, thus a license header is optional.
+Generated files do not require license headers.
+
+0 Unknown Licenses
+
+*****************************************************
+ Files with Apache License headers will be marked AL
+ Binary files (which do not require any license headers) will be marked B
+ Compressed archives will be marked A
+ Notices, licenses etc. will be marked N
+ N incubator-servicecomb-service-center/DISCLAIMER
+ N incubator-servicecomb-service-center/LICENSE
+ N incubator-servicecomb-service-center/NOTICE
+ AL incubator-servicecomb-service-center/main.go
+ B incubator-servicecomb-service-center/docs/Service-Center-UI-Preview.gif
+ B incubator-servicecomb-service-center/docs/communication.PNG
+ B incubator-servicecomb-service-center/docs/onStartup.PNG
+ B incubator-servicecomb-service-center/docs/tracing-file.PNG
+ B incubator-servicecomb-service-center/docs/tracing-server.PNG
+ AL incubator-servicecomb-service-center/examples/service_center/request/add_dependecy.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/create_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/delete_instance.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/delete_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_consumers.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_providers.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/heartbeat.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/register_intance_json.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/update_properties.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/update_status.sh
+ AL incubator-servicecomb-service-center/frontend/main.go
+ B incubator-servicecomb-service-center/frontend/app/favicon.ico
+ AL incubator-servicecomb-service-center/frontend/app/apiList/apiList.js
+ B incubator-servicecomb-service-center/frontend/app/images/loader.gif
+ B incubator-servicecomb-service-center/frontend/app/images/sc.png
+ B incubator-servicecomb-service-center/frontend/app/images/yeoman.png
+ AL incubator-servicecomb-service-center/frontend/app/scripts/app.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/scRouterConfig.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/controllers/serviceCenterCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/directives/nodataFoundDirective.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/directives/tableDirective.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-cz.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-en.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/dashboard/controllers/dashboardCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/schemaCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/serviceInfoCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/servicesListCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/filters/formatSchema.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/services/commonService.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/services/httpService.js
+ AL incubator-servicecomb-service-center/frontend/app/styles/main.css
+ AL incubator-servicecomb-service-center/frontend/schema/schemahandler.go
+ AL incubator-servicecomb-service-center/integration/apis.go
+ AL incubator-servicecomb-service-center/integration/governance_test.go
+ AL incubator-servicecomb-service-center/integration/health_test.go
+ AL incubator-servicecomb-service-center/integration/instances_test.go
+ AL incubator-servicecomb-service-center/integration/integrationtest_suite_test.go
+ AL incubator-servicecomb-service-center/integration/microservices_test.go
+ AL incubator-servicecomb-service-center/integration/rules_test.go
+ AL incubator-servicecomb-service-center/integration/schema_test.go
+ AL incubator-servicecomb-service-center/integration/tags_test.go
+ AL incubator-servicecomb-service-center/pkg/async/async_task.go
+ AL incubator-servicecomb-service-center/pkg/async/async_task_test.go
+ AL incubator-servicecomb-service-center/pkg/chain/callback.go
+ AL incubator-servicecomb-service-center/pkg/chain/chain.go
+ AL incubator-servicecomb-service-center/pkg/chain/chain_test.go
+ AL incubator-servicecomb-service-center/pkg/chain/handler.go
+ AL incubator-servicecomb-service-center/pkg/chain/invocation.go
+ AL incubator-servicecomb-service-center/pkg/errors/error.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/etcdsync_suite_test.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/mutex.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/mutex_test.go
+ AL incubator-servicecomb-service-center/pkg/grace/grace.go
+ AL incubator-servicecomb-service-center/pkg/plugin/loader.go
+ AL incubator-servicecomb-service-center/pkg/plugin/loader_test.go
+ AL incubator-servicecomb-service-center/pkg/rest/client.go
+ AL incubator-servicecomb-service-center/pkg/rest/common.go
+ AL incubator-servicecomb-service-center/pkg/rest/conn.go
+ AL incubator-servicecomb-service-center/pkg/rest/listener.go
+ AL incubator-servicecomb-service-center/pkg/rest/roa.go
+ AL incubator-servicecomb-service-center/pkg/rest/route.go
+ AL incubator-servicecomb-service-center/pkg/rest/server.go
+ AL incubator-servicecomb-service-center/pkg/rpc/grpc.go
+ AL incubator-servicecomb-service-center/pkg/tlsutil/tlsutil.go
+ AL incubator-servicecomb-service-center/pkg/util/concurrent_map.go
+ AL incubator-servicecomb-service-center/pkg/util/concurrent_map_test.go
+ AL incubator-servicecomb-service-center/pkg/util/context.go
+ AL incubator-servicecomb-service-center/pkg/util/goroutines.go
+ AL incubator-servicecomb-service-center/pkg/util/goroutines_test.go
+ AL incubator-servicecomb-service-center/pkg/util/log.go
+ AL incubator-servicecomb-service-center/pkg/util/log_test.go
+ AL incubator-servicecomb-service-center/pkg/util/logrotate.go
+ AL incubator-servicecomb-service-center/pkg/util/metric.go
+ AL incubator-servicecomb-service-center/pkg/util/net.go
+ AL incubator-servicecomb-service-center/pkg/util/net_test.go
+ AL incubator-servicecomb-service-center/pkg/util/reflect.go
+ AL incubator-servicecomb-service-center/pkg/util/reflect_test.go
+ AL incubator-servicecomb-service-center/pkg/util/sys.go
+ AL incubator-servicecomb-service-center/pkg/util/tree.go
+ AL incubator-servicecomb-service-center/pkg/util/tree_test.go
+ AL incubator-servicecomb-service-center/pkg/util/uniqueue.go
+ AL incubator-servicecomb-service-center/pkg/util/uniqueue_test.go
+ AL incubator-servicecomb-service-center/pkg/util/util.go
+ AL incubator-servicecomb-service-center/pkg/util/util_test.go
+ AL incubator-servicecomb-service-center/pkg/util/uuid.go
+ AL incubator-servicecomb-service-center/pkg/validate/url.go
+ AL incubator-servicecomb-service-center/pkg/validate/validate.go
+ AL incubator-servicecomb-service-center/scripts/create_gvt_manifest(exp).sh
+ AL incubator-servicecomb-service-center/scripts/integration_test.sh
+ AL incubator-servicecomb-service-center/scripts/prepare_env_ut.sh
+ AL incubator-servicecomb-service-center/scripts/ut.sh
+ AL incubator-servicecomb-service-center/scripts/ut_test_in_docker.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-frontend-image/build.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-image/build.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-image/start.sh
+ N incubator-servicecomb-service-center/scripts/release/LICENSE
+ N incubator-servicecomb-service-center/scripts/release/NOTICE
+ AL incubator-servicecomb-service-center/scripts/release/make_release.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/start-frontend.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/start-service-center.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/stop-frontend.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/stop-service-center.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/windows/start-frontend.bat
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/windows/start-service-center.bat
+ AL incubator-servicecomb-service-center/server/api.go
+ AL incubator-servicecomb-service-center/server/server.go
+ AL incubator-servicecomb-service-center/server/bootstrap/bootstrap.go
+ AL incubator-servicecomb-service-center/server/broker/broker.go
+ AL incubator-servicecomb-service-center/server/broker/broker_key_generator.go
+ AL incubator-servicecomb-service-center/server/broker/controller.go
+ AL incubator-servicecomb-service-center/server/broker/service.go
+ AL incubator-servicecomb-service-center/server/broker/service_test.go
+ AL incubator-servicecomb-service-center/server/broker/store.go
+ AL incubator-servicecomb-service-center/server/broker/util.go
+ AL incubator-servicecomb-service-center/server/core/0_init.go
+ AL incubator-servicecomb-service-center/server/core/common.go
+ AL incubator-servicecomb-service-center/server/core/info.go
+ AL incubator-servicecomb-service-center/server/core/key_generator.go
+ AL incubator-servicecomb-service-center/server/core/microservice.go
+ AL incubator-servicecomb-service-center/server/core/backend/backend.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/async.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/cacher.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/defer.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/defer_test.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/event.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/indexer.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/lease.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/listwatch.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/opt.go
+ AL incubator-servicecomb-service-center/server/core/backend/store/store.go
+ AL incubator-servicecomb-service-center/server/core/proto/services.go
+ AL incubator-servicecomb-service-center/server/error/error.go
+ AL incubator-servicecomb-service-center/server/govern/controller_v3.go
+ AL incubator-servicecomb-service-center/server/govern/controller_v4.go
+ AL incubator-servicecomb-service-center/server/govern/govern.go
+ AL incubator-servicecomb-service-center/server/govern/govern_suite_test.go
+ AL incubator-servicecomb-service-center/server/govern/service.go
+ AL incubator-servicecomb-service-center/server/govern/service_test.go
+ AL incubator-servicecomb-service-center/server/handler/auth/auth.go
+ AL incubator-servicecomb-service-center/server/handler/cache/cache.go
+ AL incubator-servicecomb-service-center/server/handler/context/context.go
+ AL incubator-servicecomb-service-center/server/handler/context/v3.go
+ AL incubator-servicecomb-service-center/server/handler/context/v4.go
+ AL incubator-servicecomb-service-center/server/handler/metric/metric.go
+ AL incubator-servicecomb-service-center/server/handler/tracing/tracing.go
+ AL incubator-servicecomb-service-center/server/infra/auditlog/auditlog.go
+ AL incubator-servicecomb-service-center/server/infra/auth/auth.go
+ AL incubator-servicecomb-service-center/server/infra/quota/quota.go
+ AL incubator-servicecomb-service-center/server/infra/registry/registry.go
+ AL incubator-servicecomb-service-center/server/infra/security/cipher.go
+ AL incubator-servicecomb-service-center/server/infra/tracing/tracing.go
+ AL incubator-servicecomb-service-center/server/infra/uuid/uuid.go
+ AL incubator-servicecomb-service-center/server/interceptor/interceptors.go
+ AL incubator-servicecomb-service-center/server/interceptor/access/access.go
+ AL incubator-servicecomb-service-center/server/interceptor/cors/cors.go
+ AL incubator-servicecomb-service-center/server/mux/mux.go
+ AL incubator-servicecomb-service-center/server/plugin/plugin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/auth/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/quota/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/quota/unlimit/unlimit.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/embededetcd/embededetcd.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/etcd.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/tracing.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/security/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/common.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/file_collector.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span_test.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/uuid/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/rest/handler.go
+ AL incubator-servicecomb-service-center/server/rest/metric.go
+ AL incubator-servicecomb-service-center/server/rest/server.go
+ AL incubator-servicecomb-service-center/server/rest/controller/rest_util.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/dependency_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_watcher.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/main_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/microservice_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/query_rule_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/schema_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/tag_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/v3.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/dependency_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_watcher.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/main_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/microservice_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/query_rule_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/schema_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/tag_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/v4.go
+ AL incubator-servicecomb-service-center/server/rpc/server.go
+ AL incubator-servicecomb-service-center/server/service/concurrent_test.go
+ AL incubator-servicecomb-service-center/server/service/instances.go
+ AL incubator-servicecomb-service-center/server/service/instances_test.go
+ AL incubator-servicecomb-service-center/server/service/microservices.go
+ AL incubator-servicecomb-service-center/server/service/microservices_test.go
+ AL incubator-servicecomb-service-center/server/service/resource_assembler.go
+ AL incubator-servicecomb-service-center/server/service/rule.go
+ AL incubator-servicecomb-service-center/server/service/rule_test.go
+ AL incubator-servicecomb-service-center/server/service/schema.go
+ AL incubator-servicecomb-service-center/server/service/schema_test.go
+ AL incubator-servicecomb-service-center/server/service/service_dependency.go
+ AL incubator-servicecomb-service-center/server/service/service_dependency_test.go
+ AL incubator-servicecomb-service-center/server/service/service_suite_test.go
+ AL incubator-servicecomb-service-center/server/service/tag.go
+ AL incubator-servicecomb-service-center/server/service/tag_test.go
+ AL incubator-servicecomb-service-center/server/service/event/dependency_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/event.go
+ AL incubator-servicecomb-service-center/server/service/event/instance_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/rule_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/service_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/tag_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/notification/listwatcher.go
+ AL incubator-servicecomb-service-center/server/service/notification/notification_healthchecker.go
+ AL incubator-servicecomb-service-center/server/service/notification/notification_service.go
+ AL incubator-servicecomb-service-center/server/service/notification/struct.go
+ AL incubator-servicecomb-service-center/server/service/notification/watch_util.go
+ AL incubator-servicecomb-service-center/server/service/util/dependency.go
+ AL incubator-servicecomb-service-center/server/service/util/dependency_test.go
+ AL incubator-servicecomb-service-center/server/service/util/domain_util.go
+ AL incubator-servicecomb-service-center/server/service/util/domain_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/heartbeat_util.go
+ AL incubator-servicecomb-service-center/server/service/util/heartbeat_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/instance_util.go
+ AL incubator-servicecomb-service-center/server/service/util/instance_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/microservice_util.go
+ AL incubator-servicecomb-service-center/server/service/util/rule_util.go
+ AL incubator-servicecomb-service-center/server/service/util/rule_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/schema_util.go
+ AL incubator-servicecomb-service-center/server/service/util/schema_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/tag_util.go
+ AL incubator-servicecomb-service-center/server/service/util/tag_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/util.go
+ AL incubator-servicecomb-service-center/server/service/util/util_suite_test.go
+ AL incubator-servicecomb-service-center/server/service/util/versionrule.go
+ AL incubator-servicecomb-service-center/server/service/util/versionrule_test.go
+ AL incubator-servicecomb-service-center/server/tls/tls.go
+ AL incubator-servicecomb-service-center/version/version.go
+
+*****************************************************
+```
\ No newline at end of file
diff --git a/service-center-reference/en_US/release/rat-report/Rat-Report-2018-06-01.md b/service-center-reference/en_US/release/rat-report/Rat-Report-2018-06-01.md
new file mode 100644
index 0000000..964595f
--- /dev/null
+++ b/service-center-reference/en_US/release/rat-report/Rat-Report-2018-06-01.md
@@ -0,0 +1,349 @@
+```
+ java -jar apache-rat-0.12.jar -a -d incubator-servicecomb-service-center/ -e *.md *.MD .gitignore .gitmodules .travis.yml manifest **vendor** **licenses** bower.json
+
+*****************************************************
+Summary
+-------
+Generated at: 2018-06-01T15:44:00+05:30
+
+Notes: 5
+Binaries: 8
+Archives: 0
+Standards: 305
+
+Apache Licensed: 305
+Generated Documents: 0
+
+JavaDocs are generated, thus a license header is optional.
+Generated files do not require license headers.
+
+0 Unknown Licenses
+
+*****************************************************
+ Files with Apache License headers will be marked AL
+ Binary files (which do not require any license headers) will be marked B
+ Compressed archives will be marked A
+ Notices, licenses etc. will be marked N
+ N incubator-servicecomb-service-center/DISCLAIMER
+ AL incubator-servicecomb-service-center/Dockerfile
+ N incubator-servicecomb-service-center/LICENSE
+ N incubator-servicecomb-service-center/NOTICE
+ AL incubator-servicecomb-service-center/main.go
+ B incubator-servicecomb-service-center/docs/Service-Center-UI-Preview.gif
+ AL incubator-servicecomb-service-center/docs/api-docs.html
+ B incubator-servicecomb-service-center/docs/communication.PNG
+ B incubator-servicecomb-service-center/docs/onStartup.PNG
+ B incubator-servicecomb-service-center/docs/tracing-file.PNG
+ B incubator-servicecomb-service-center/docs/tracing-server.PNG
+ AL incubator-servicecomb-service-center/etc/conf/app.conf
+ AL incubator-servicecomb-service-center/examples/service_center/body/add_dependency_request.json
+ AL incubator-servicecomb-service-center/examples/service_center/body/create_service_response.json
+ AL incubator-servicecomb-service-center/examples/service_center/body/get_allservice_response.json
+ AL incubator-servicecomb-service-center/examples/service_center/body/get_consumers_response.json
+ AL incubator-servicecomb-service-center/examples/service_center/body/get_instance_response.json
+ AL incubator-servicecomb-service-center/examples/service_center/body/get_providers_response.json
+ AL incubator-servicecomb-service-center/examples/service_center/request/add_dependecy.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/create_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/delete_instance.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/delete_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_consumers.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_providers.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/get_service.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/heartbeat.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/register_intance_json.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/update_properties.sh
+ AL incubator-servicecomb-service-center/examples/service_center/request/update_status.sh
+ AL incubator-servicecomb-service-center/frontend/main.go
+ AL incubator-servicecomb-service-center/frontend/server.go
+ AL incubator-servicecomb-service-center/frontend/server_test.go
+ AL incubator-servicecomb-service-center/frontend/app/404.html
+ B incubator-servicecomb-service-center/frontend/app/favicon.ico
+ AL incubator-servicecomb-service-center/frontend/app/index.html
+ AL incubator-servicecomb-service-center/frontend/app/apiList/apiList.js
+ B incubator-servicecomb-service-center/frontend/app/images/loader.gif
+ B incubator-servicecomb-service-center/frontend/app/images/sc.png
+ AL incubator-servicecomb-service-center/frontend/app/scripts/app.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/scRouterConfig.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/controllers/serviceCenterCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/directives/nodataFoundDirective.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/directives/tableDirective.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-cz.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/languages/locale-en.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/dashboard/controllers/dashboardCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/dashboard/views/dashboard.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/schemaCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/serviceInfoCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/controllers/servicesListCtrl.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/filters/formatSchema.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/views/schema.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/views/serviceConsumer.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/views/serviceInfo.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/views/serviceInstance.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/views/serviceProvider.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/views/servicesList.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/modules/serviceCenter/views/testSchema.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/services/commonService.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/services/httpService.js
+ AL incubator-servicecomb-service-center/frontend/app/scripts/views/index.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/views/nodataFoundDirective.html
+ AL incubator-servicecomb-service-center/frontend/app/scripts/views/tableData.html
+ AL incubator-servicecomb-service-center/frontend/app/styles/main.css
+ AL incubator-servicecomb-service-center/frontend/app/views/error.html
+ AL incubator-servicecomb-service-center/frontend/app/views/serverError.html
+ AL incubator-servicecomb-service-center/frontend/schema/schemahandler.go
+ AL incubator-servicecomb-service-center/integration/apis.go
+ AL incubator-servicecomb-service-center/integration/governance_test.go
+ AL incubator-servicecomb-service-center/integration/health-metrics-grafana.json
+ AL incubator-servicecomb-service-center/integration/health_test.go
+ AL incubator-servicecomb-service-center/integration/instances_test.go
+ AL incubator-servicecomb-service-center/integration/integrationtest_suite_test.go
+ AL incubator-servicecomb-service-center/integration/microservices_test.go
+ AL incubator-servicecomb-service-center/integration/rules_test.go
+ AL incubator-servicecomb-service-center/integration/schema_test.go
+ AL incubator-servicecomb-service-center/integration/tags_test.go
+ AL incubator-servicecomb-service-center/pkg/async/async.go
+ AL incubator-servicecomb-service-center/pkg/async/async_task.go
+ AL incubator-servicecomb-service-center/pkg/async/async_task_test.go
+ AL incubator-servicecomb-service-center/pkg/chain/callback.go
+ AL incubator-servicecomb-service-center/pkg/chain/chain.go
+ AL incubator-servicecomb-service-center/pkg/chain/chain_test.go
+ AL incubator-servicecomb-service-center/pkg/chain/handler.go
+ AL incubator-servicecomb-service-center/pkg/chain/invocation.go
+ AL incubator-servicecomb-service-center/pkg/errors/error.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/etcdsync_suite_test.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/mutex.go
+ AL incubator-servicecomb-service-center/pkg/etcdsync/mutex_test.go
+ AL incubator-servicecomb-service-center/pkg/grace/grace.go
+ AL incubator-servicecomb-service-center/pkg/plugin/loader.go
+ AL incubator-servicecomb-service-center/pkg/plugin/loader_test.go
+ AL incubator-servicecomb-service-center/pkg/rest/client.go
+ AL incubator-servicecomb-service-center/pkg/rest/common.go
+ AL incubator-servicecomb-service-center/pkg/rest/conn.go
+ AL incubator-servicecomb-service-center/pkg/rest/listener.go
+ AL incubator-servicecomb-service-center/pkg/rest/roa.go
+ AL incubator-servicecomb-service-center/pkg/rest/route.go
+ AL incubator-servicecomb-service-center/pkg/rest/server.go
+ AL incubator-servicecomb-service-center/pkg/rpc/grpc.go
+ AL incubator-servicecomb-service-center/pkg/tlsutil/tlsutil.go
+ AL incubator-servicecomb-service-center/pkg/tlsutil/tlsutil_test.go
+ AL incubator-servicecomb-service-center/pkg/util/backoff.go
+ AL incubator-servicecomb-service-center/pkg/util/backoff_test.go
+ AL incubator-servicecomb-service-center/pkg/util/concurrent_map.go
+ AL incubator-servicecomb-service-center/pkg/util/concurrent_map_test.go
+ AL incubator-servicecomb-service-center/pkg/util/context.go
+ AL incubator-servicecomb-service-center/pkg/util/goroutines.go
+ AL incubator-servicecomb-service-center/pkg/util/goroutines_test.go
+ AL incubator-servicecomb-service-center/pkg/util/log.go
+ AL incubator-servicecomb-service-center/pkg/util/log_test.go
+ AL incubator-servicecomb-service-center/pkg/util/logrotate.go
+ AL incubator-servicecomb-service-center/pkg/util/logrotate_test.go
+ AL incubator-servicecomb-service-center/pkg/util/metric.go
+ AL incubator-servicecomb-service-center/pkg/util/net.go
+ AL incubator-servicecomb-service-center/pkg/util/net_test.go
+ AL incubator-servicecomb-service-center/pkg/util/reflect.go
+ AL incubator-servicecomb-service-center/pkg/util/reflect_test.go
+ AL incubator-servicecomb-service-center/pkg/util/sys.go
+ AL incubator-servicecomb-service-center/pkg/util/tree.go
+ AL incubator-servicecomb-service-center/pkg/util/tree_test.go
+ AL incubator-servicecomb-service-center/pkg/util/uniqueue.go
+ AL incubator-servicecomb-service-center/pkg/util/uniqueue_test.go
+ AL incubator-servicecomb-service-center/pkg/util/util.go
+ AL incubator-servicecomb-service-center/pkg/util/util_test.go
+ AL incubator-servicecomb-service-center/pkg/util/uuid.go
+ AL incubator-servicecomb-service-center/pkg/validate/func.go
+ AL incubator-servicecomb-service-center/pkg/validate/rule.go
+ AL incubator-servicecomb-service-center/pkg/validate/url.go
+ AL incubator-servicecomb-service-center/pkg/validate/validator.go
+ AL incubator-servicecomb-service-center/pkg/validate/validator_test.go
+ AL incubator-servicecomb-service-center/scripts/create_gvt_manifest(exp).sh
+ AL incubator-servicecomb-service-center/scripts/integration_test.sh
+ AL incubator-servicecomb-service-center/scripts/prepare_env_ut.sh
+ AL incubator-servicecomb-service-center/scripts/ut.sh
+ AL incubator-servicecomb-service-center/scripts/ut_test_in_docker.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-frontend-image/Dockerfile.tmpl
+ AL incubator-servicecomb-service-center/scripts/docker/build-frontend-image/build.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-image/Dockerfile.tmpl
+ AL incubator-servicecomb-service-center/scripts/docker/build-image/build.sh
+ AL incubator-servicecomb-service-center/scripts/docker/build-image/start.sh
+ AL incubator-servicecomb-service-center/scripts/release/Dockerfile
+ N incubator-servicecomb-service-center/scripts/release/LICENSE
+ N incubator-servicecomb-service-center/scripts/release/NOTICE
+ AL incubator-servicecomb-service-center/scripts/release/make_release.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/start-frontend.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/start-service-center.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/stop-frontend.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/linux/stop-service-center.sh
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/windows/start-frontend.bat
+ AL incubator-servicecomb-service-center/scripts/release/start_scripts/windows/start-service-center.bat
+ AL incubator-servicecomb-service-center/server/api.go
+ AL incubator-servicecomb-service-center/server/server.go
+ AL incubator-servicecomb-service-center/server/bootstrap/bootstrap.go
+ AL incubator-servicecomb-service-center/server/broker/broker.go
+ AL incubator-servicecomb-service-center/server/broker/broker.pb.go
+ AL incubator-servicecomb-service-center/server/broker/broker.proto
+ AL incubator-servicecomb-service-center/server/broker/broker_key_generator.go
+ AL incubator-servicecomb-service-center/server/broker/broker_suite_test.go
+ AL incubator-servicecomb-service-center/server/broker/controller.go
+ AL incubator-servicecomb-service-center/server/broker/service.go
+ AL incubator-servicecomb-service-center/server/broker/service_test.go
+ AL incubator-servicecomb-service-center/server/broker/store.go
+ AL incubator-servicecomb-service-center/server/broker/util.go
+ AL incubator-servicecomb-service-center/server/core/config.go
+ AL incubator-servicecomb-service-center/server/core/core.go
+ AL incubator-servicecomb-service-center/server/core/key_generator.go
+ AL incubator-servicecomb-service-center/server/core/microservice.go
+ AL incubator-servicecomb-service-center/server/core/backend/backend.go
+ AL incubator-servicecomb-service-center/server/core/backend/cache_kv.go
+ AL incubator-servicecomb-service-center/server/core/backend/cache_null.go
+ AL incubator-servicecomb-service-center/server/core/backend/cacher.go
+ AL incubator-servicecomb-service-center/server/core/backend/cacher_test.go
+ AL incubator-servicecomb-service-center/server/core/backend/common.go
+ AL incubator-servicecomb-service-center/server/core/backend/config.go
+ AL incubator-servicecomb-service-center/server/core/backend/defer.go
+ AL incubator-servicecomb-service-center/server/core/backend/defer_instance.go
+ AL incubator-servicecomb-service-center/server/core/backend/defer_test.go
+ AL incubator-servicecomb-service-center/server/core/backend/event.go
+ AL incubator-servicecomb-service-center/server/core/backend/event_proxy.go
+ AL incubator-servicecomb-service-center/server/core/backend/extend.go
+ AL incubator-servicecomb-service-center/server/core/backend/extend_test.go
+ AL incubator-servicecomb-service-center/server/core/backend/indexer.go
+ AL incubator-servicecomb-service-center/server/core/backend/lease.go
+ AL incubator-servicecomb-service-center/server/core/backend/listwatch.go
+ AL incubator-servicecomb-service-center/server/core/backend/metric.go
+ AL incubator-servicecomb-service-center/server/core/backend/store.go
+ AL incubator-servicecomb-service-center/server/core/proto/services.go
+ AL incubator-servicecomb-service-center/server/core/proto/services.pb.go
+ AL incubator-servicecomb-service-center/server/core/proto/services.proto
+ AL incubator-servicecomb-service-center/server/core/swagger/v3.yaml
+ AL incubator-servicecomb-service-center/server/core/swagger/v4.yaml
+ AL incubator-servicecomb-service-center/server/error/error.go
+ AL incubator-servicecomb-service-center/server/error/error_test.go
+ AL incubator-servicecomb-service-center/server/govern/controller_v3.go
+ AL incubator-servicecomb-service-center/server/govern/controller_v4.go
+ AL incubator-servicecomb-service-center/server/govern/govern.go
+ AL incubator-servicecomb-service-center/server/govern/govern_suite_test.go
+ AL incubator-servicecomb-service-center/server/govern/service.go
+ AL incubator-servicecomb-service-center/server/govern/service_test.go
+ AL incubator-servicecomb-service-center/server/handler/auth/auth.go
+ AL incubator-servicecomb-service-center/server/handler/cache/cache.go
+ AL incubator-servicecomb-service-center/server/handler/context/context.go
+ AL incubator-servicecomb-service-center/server/handler/context/v3.go
+ AL incubator-servicecomb-service-center/server/handler/context/v4.go
+ AL incubator-servicecomb-service-center/server/handler/metric/metric.go
+ AL incubator-servicecomb-service-center/server/handler/tracing/tracing.go
+ AL incubator-servicecomb-service-center/server/infra/auditlog/auditlog.go
+ AL incubator-servicecomb-service-center/server/infra/auth/auth.go
+ AL incubator-servicecomb-service-center/server/infra/quota/quota.go
+ AL incubator-servicecomb-service-center/server/infra/registry/registry.go
+ AL incubator-servicecomb-service-center/server/infra/security/cipher.go
+ AL incubator-servicecomb-service-center/server/infra/tracing/tracing.go
+ AL incubator-servicecomb-service-center/server/infra/uuid/uuid.go
+ AL incubator-servicecomb-service-center/server/interceptor/interceptors.go
+ AL incubator-servicecomb-service-center/server/interceptor/access/access.go
+ AL incubator-servicecomb-service-center/server/interceptor/cors/cors.go
+ AL incubator-servicecomb-service-center/server/mux/mux.go
+ AL incubator-servicecomb-service-center/server/plugin/plugin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/auth/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/quota/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/quota/unlimit/unlimit.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/embededetcd/embededetcd.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/etcd.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/etcd_test.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/logger.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/registry/etcd/tracing.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/security/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/common.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/file_collector.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/file_collector_test.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/tracing/buildin/span_test.go
+ AL incubator-servicecomb-service-center/server/plugin/infra/uuid/buildin/buildin.go
+ AL incubator-servicecomb-service-center/server/rest/handler.go
+ AL incubator-servicecomb-service-center/server/rest/metric.go
+ AL incubator-servicecomb-service-center/server/rest/pprof.go
+ AL incubator-servicecomb-service-center/server/rest/server.go
+ AL incubator-servicecomb-service-center/server/rest/server_mux.go
+ AL incubator-servicecomb-service-center/server/rest/controller/rest_util.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/dependency_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/instance_watcher.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/main_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/microservice_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/query_rule_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/schema_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/tag_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v3/v3.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/dependency_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/instance_watcher.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/main_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/microservice_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/query_rule_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/schema_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/tag_controller.go
+ AL incubator-servicecomb-service-center/server/rest/controller/v4/v4.go
+ AL incubator-servicecomb-service-center/server/rpc/server.go
+ AL incubator-servicecomb-service-center/server/service/concurrent_test.go
+ AL incubator-servicecomb-service-center/server/service/dependency.go
+ AL incubator-servicecomb-service-center/server/service/dependency_test.go
+ AL incubator-servicecomb-service-center/server/service/dependency_validator.go
+ AL incubator-servicecomb-service-center/server/service/instance.go
+ AL incubator-servicecomb-service-center/server/service/instance_test.go
+ AL incubator-servicecomb-service-center/server/service/instance_validator.go
+ AL incubator-servicecomb-service-center/server/service/microservice.go
+ AL incubator-servicecomb-service-center/server/service/microservice_test.go
+ AL incubator-servicecomb-service-center/server/service/microservice_validator.go
+ AL incubator-servicecomb-service-center/server/service/rule.go
+ AL incubator-servicecomb-service-center/server/service/rule_test.go
+ AL incubator-servicecomb-service-center/server/service/rule_validator.go
+ AL incubator-servicecomb-service-center/server/service/schema.go
+ AL incubator-servicecomb-service-center/server/service/schema_test.go
+ AL incubator-servicecomb-service-center/server/service/schema_validator.go
+ AL incubator-servicecomb-service-center/server/service/service.go
+ AL incubator-servicecomb-service-center/server/service/service_suite_test.go
+ AL incubator-servicecomb-service-center/server/service/tag.go
+ AL incubator-servicecomb-service-center/server/service/tag_test.go
+ AL incubator-servicecomb-service-center/server/service/tag_validator.go
+ AL incubator-servicecomb-service-center/server/service/validate.go
+ AL incubator-servicecomb-service-center/server/service/watch.go
+ AL incubator-servicecomb-service-center/server/service/watch_test.go
+ AL incubator-servicecomb-service-center/server/service/event/dependency_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/event.go
+ AL incubator-servicecomb-service-center/server/service/event/instance_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/rule_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/service_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/event/tag_event_handler.go
+ AL incubator-servicecomb-service-center/server/service/notification/listwatcher.go
+ AL incubator-servicecomb-service-center/server/service/notification/notification_healthchecker.go
+ AL incubator-servicecomb-service-center/server/service/notification/notification_service.go
+ AL incubator-servicecomb-service-center/server/service/notification/struct.go
+ AL incubator-servicecomb-service-center/server/service/notification/watch_util.go
+ AL incubator-servicecomb-service-center/server/service/util/common.go
+ AL incubator-servicecomb-service-center/server/service/util/dependency.go
+ AL incubator-servicecomb-service-center/server/service/util/dependency_test.go
+ AL incubator-servicecomb-service-center/server/service/util/domain_util.go
+ AL incubator-servicecomb-service-center/server/service/util/domain_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/heartbeat_util.go
+ AL incubator-servicecomb-service-center/server/service/util/heartbeat_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/instance_util.go
+ AL incubator-servicecomb-service-center/server/service/util/instance_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/microservice_util.go
+ AL incubator-servicecomb-service-center/server/service/util/rule_util.go
+ AL incubator-servicecomb-service-center/server/service/util/rule_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/schema_util.go
+ AL incubator-servicecomb-service-center/server/service/util/schema_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/tag_util.go
+ AL incubator-servicecomb-service-center/server/service/util/tag_util_test.go
+ AL incubator-servicecomb-service-center/server/service/util/util.go
+ AL incubator-servicecomb-service-center/server/service/util/util_suite_test.go
+ AL incubator-servicecomb-service-center/server/service/util/versionrule.go
+ AL incubator-servicecomb-service-center/server/service/util/versionrule_test.go
+ AL incubator-servicecomb-service-center/server/tls/tls.go
+ AL incubator-servicecomb-service-center/version/version.go
+
+*****************************************************
+
+
+```
\ No newline at end of file
diff --git a/service-center-reference/en_US/release/releaseNotes-1.0.0-m1.md b/service-center-reference/en_US/release/releaseNotes-1.0.0-m1.md
new file mode 100644
index 0000000..7158fbb
--- /dev/null
+++ b/service-center-reference/en_US/release/releaseNotes-1.0.0-m1.md
@@ -0,0 +1,30 @@
+## Release Notes
+
+### Apache ServiceComb Service-Center (incubating) version 1.0.0-m1
+#### API Changes :
+ * Added new API to get All Schema List.
+ * Add Service statistics in the Governance API.
+ * Add Self-microservice information in the Governance API.
+
+#### New Features/Improvements:
+* Support discovery of SC instances by Consumer micro-service.
+* Event driven implementation for dependency rules.
+* Make compact interval configurable and avoid defragmentation of the database when compacted.
+* Update the default quota’s limit of service/instance count.
+* Update black-list rule controls in discovery.
+
+#### Metrics :
+* Added support for Prometheus metrics exposure.
+* Added templates for Grafana Dashboard.
+
+#### Optimization:
+* Optimized Restful clients and plugins loader.
+* Optimized Service-Count calculation rule.
+* Use CDN for resolving all the dependencies of frontend.
+
+#### Bug-Fix:
+* Fix panic issue while deleting instance and invalid metrics request.
+* Fix modify schema response issue and heart-beat failure when etcd has no leader.
+* Fix batch delete api to exempt from unregistering service-center microservice.
+* Fix watcher wrong event sequence when SC modify resource concurrently
+* Fix discovery of default APP services in Shared service mode
diff --git a/service-center-reference/en_US/release/releaseNotes-1.0.0-m2.md b/service-center-reference/en_US/release/releaseNotes-1.0.0-m2.md
new file mode 100644
index 0000000..0bc5247
--- /dev/null
+++ b/service-center-reference/en_US/release/releaseNotes-1.0.0-m2.md
@@ -0,0 +1,39 @@
+## Release Notes
+
+### Apache ServiceComb Service-Center (incubating) version 1.0.0-m2
+
+#### API Changes :
+* Governance API also returns self microservice information.
+* Governance API should not show the shared microservices information.
+* Support batch delete in registry.
+* Change the type of force query parameter to bool in delete api.
+
+#### New Features/Improvements:
+* Support Async Rest Template.
+* Support of Testing Schema from frontend.
+* Support log rotation.
+* Support ipv6.
+* Static data return instanceCount by domain.
+* Convenient store extension.
+* Retry the connection to etcd in-case of failure.
+* Show proper error details in frontend.
+* Support Default TLS Cipher Suites.
+* Proxy Frontend request to Service-Center.
+* Use bower to resolve the dependency of frontend.
+* Add registry server HC mechanism.
+
+#### Bug-Fix:
+* Fix issue of filter instance using service-tags.
+* Fix re-creation of tracing file.
+* Fix SC cannot check duplicate endpoints when registered with etcd.
+* Fix wrong parentId in tracing data.
+* Fix wrong log print in update Instance.
+* Fix null pointer reference in zipkin plugin.
+* Fix delete service should delete dependency key.
+* Fix cache does not match with etcd store.
+* Fix remove the backup log files which are expired.
+* Fix typos in response of schema api's.
+* Fix incorrect metric label value.
+* Fix register instance withe same id will create redundant endpoints.
+
+###### For more details please [click here](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12321626&version=12342354)
\ No newline at end of file
diff --git a/service-center-reference/en_US/release/releaseNotes-1.0.0.md b/service-center-reference/en_US/release/releaseNotes-1.0.0.md
new file mode 100644
index 0000000..1ba7b7f
--- /dev/null
+++ b/service-center-reference/en_US/release/releaseNotes-1.0.0.md
@@ -0,0 +1,21 @@
+## Release Notes
+
+### Apache ServiceComb Service-Center (incubating) version 1.0.0
+
+#### New Features/Improvements:
+ - Make ETCD connection more Resilient
+ - Make ETCD request timeout configurable
+ - Support TLS Plugin
+ - Optimize Governance API for Searching Schema
+ - Optimize Find Instance API
+ - Use glide for dependency management
+ - Add release binaries for MacOS
+ - Add Toplogy View and Instance View in UI
+
+
+#### Bug-Fix:
+ - Fix connection leak in etcd
+ - Fix Lose of events in some scenarios
+ - Fix Cache mismatch.
+
+###### For more details please [click here](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12321626&version=12342427)
diff --git a/service-center-reference/en_US/sc-cluster.md b/service-center-reference/en_US/sc-cluster.md
new file mode 100644
index 0000000..ea2ddf2
--- /dev/null
+++ b/service-center-reference/en_US/sc-cluster.md
@@ -0,0 +1,109 @@
+### Deploying Service-Center in Cluster Mode
+
+As Service-center is a stateless application so it can be seamlessly deployed in cluster mode to achieve HA.
+SC is dependent on the etcd to store the microservices information so you can opt for running etcd standalone or in [cluster](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/container.md) mode.
+Once you are done with installing the etcd either in cluster or standalone mode then you can follow the below steps to run the Service-Center.
+
+Let's assume you want to install 2 instances of Service-Center on VM with following details
+
+| Name | Address |
+| :-----: | :---------: |
+| VM1 | 10.12.0.1 |
+| VM2 | 10.12.0.2 |
+
+Here we assume your etcd is running on http://10.12.0.4:2379 (you can follow [this](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/container.md) guide to install etcd in cluster mode.)
+
+##### Step 1
+Download the SC release from [here](https://github.com/apache/incubator-servicecomb-service-center/releases) on all the VM's.
+```
+# Untar the release
+# tar -xvf service-center-X.X.X-linux-amd64.tar.gz
+
+```
+
+Note: Please don't run start.sh as it will also start the etcd.
+
+##### Step 2
+Edit the configuration of the ip/port on which SC will run and etcd ip
+###### VM1
+```
+# vi conf/app.conf
+#Replace the below values
+httpaddr = 10.12.0.1
+manager_cluster = "10.12.0.4:2379"
+
+# Start the Service-center
+./service-center
+```
+
+###### VM2
+```
+# vi conf/app.conf
+#Replace the below values
+httpaddr = 10.12.0.2
+manager_cluster = "10.12.0.4:2379"
+
+# Start the Service-center
+./service-center
+```
+
+Note: In `manger_cluster` you can put the multiple instances of etcd in the cluster like
+```
+manager_cluster= "10.12.0.4:2379,10.12.0.X:2379,10.12.0.X:2379"
+```
+
+#### Step 4
+Verify your instances
+```
+# curl http://10.12.0.1:30101/v4/default/registry/health
+{
+ "instances": [
+ {
+ "instanceId": "d6e9e976f9df11e7a72b286ed488ff9f",
+ "serviceId": "d6e99f4cf9df11e7a72b286ed488ff9f",
+ "endpoints": [
+ "rest://10.12.0.1:30100"
+ ],
+ "hostName": "service_center_10_12_0_1",
+ "status": "UP",
+ "healthCheck": {
+ "mode": "push",
+ "interval": 30,
+ "times": 3
+ },
+ "timestamp": "1516012543",
+ "modTimestamp": "1516012543"
+ },
+ {
+ "instanceId": "16d4cb35f9e011e7a58a286ed488ff9f",
+ "serviceId": "d6e99f4cf9df11e7a72b286ed488ff9f",
+ "endpoints": [
+ "rest://10.12.0.2:30100"
+ ],
+ "hostName": "service_center_10_12_0_2",
+ "status": "UP",
+ "healthCheck": {
+ "mode": "push",
+ "interval": 30,
+ "times": 3
+ },
+ "timestamp": "1516012650",
+ "modTimestamp": "1516012650"
+ }
+ ]
+}
+```
+
+As we can see here the Service-Center can auto-discover all the instances of the Service-Center running in cluster, this auto-discovery feature is used by the [Java-Chassis SDK](https://github.com/apache/incubator-servicecomb-java-chassis) to auto-discover all the instances of the Service-Center by knowing atleast 1 IP of Service-Center running in cluster.
+
+In your microservice.yaml you can provide the SC IP of both the instance or any one instance, sdk can auto-discover other instances and use the other instances to get microservice details in case of failure of the first one.
+```
+cse:
+ service:
+ registry:
+ address: "http://10.12.0.1:30100,http://10.12.0.2:30100"
+ autodiscovery: true
+```
+In this case sdk will be able to discover all the instances of SC in cluster.
+
+
diff --git a/service-center-reference/en_US/security-tls.md b/service-center-reference/en_US/security-tls.md
new file mode 100644
index 0000000..f0a45b0
--- /dev/null
+++ b/service-center-reference/en_US/security-tls.md
@@ -0,0 +1,18 @@
+# Setup SSL/TLS
+
+## Requirement
+Service center(SC) takes several files related SSL/TLS options.
+
+1. Environment variable 'SSL_ROOT': The directory contains certificates. If not set, uses 'etc/ssl' under the SC work directory.
+1. $SSL_ROOT/trust.cer: Trusted certificate authority.
+1. $SSL_ROOT/server.cer: Certificate used for SSL/TLS connections to SC.
+1. $SSL_ROOT/server_key.pem: Key for the certificate. If key is encrypted, 'cert_pwd' must be set.
+1. $SSL_ROOT/cert_pwd(optional): The password used to decrypt the private key.
+
+## Configuration
+Please modify the conf/app.conf before start up SC
+
+1. ssl_mode: Enabled SSL/TLS mode. [0, 1]
+1. ssl_verify_client: Whether the SC verify client(including etcd server). [0, 1]
+1. ssl_protocols: Minimal SSL/TLS protocol version. ["TLSv1.0", "TLSv1.1", "TLSv1.2"]
+1. ssl_ciphers: A list of cipher suite. By default, uses TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256
diff --git a/service-center-reference/en_US/static_files/Service-Center-UI-Preview.gif b/service-center-reference/en_US/static_files/Service-Center-UI-Preview.gif
new file mode 100644
index 0000000..8bc6adc
Binary files /dev/null and b/service-center-reference/en_US/static_files/Service-Center-UI-Preview.gif differ
diff --git a/service-center-reference/en_US/static_files/communication.PNG b/service-center-reference/en_US/static_files/communication.PNG
new file mode 100644
index 0000000..e26eea7
Binary files /dev/null and b/service-center-reference/en_US/static_files/communication.PNG differ
diff --git a/service-center-reference/en_US/static_files/integration-grafana.PNG b/service-center-reference/en_US/static_files/integration-grafana.PNG
new file mode 100644
index 0000000..e8e9609
Binary files /dev/null and b/service-center-reference/en_US/static_files/integration-grafana.PNG differ
diff --git a/service-center-reference/en_US/static_files/onStartup.PNG b/service-center-reference/en_US/static_files/onStartup.PNG
new file mode 100644
index 0000000..7d4753d
Binary files /dev/null and b/service-center-reference/en_US/static_files/onStartup.PNG differ
diff --git a/service-center-reference/en_US/static_files/tracing-file.PNG b/service-center-reference/en_US/static_files/tracing-file.PNG
new file mode 100644
index 0000000..e6ee116
Binary files /dev/null and b/service-center-reference/en_US/static_files/tracing-file.PNG differ
diff --git a/service-center-reference/en_US/static_files/tracing-server.PNG b/service-center-reference/en_US/static_files/tracing-server.PNG
new file mode 100644
index 0000000..70b7c0c
Binary files /dev/null and b/service-center-reference/en_US/static_files/tracing-server.PNG differ
diff --git a/service-center-reference/zh_CN/README.md b/service-center-reference/zh_CN/README.md
new file mode 100644
index 0000000..eb144af
--- /dev/null
+++ b/service-center-reference/zh_CN/README.md
@@ -0,0 +1,33 @@
+## Documentation Index
+
+#### [Design](/docs/design.md)
+
+#### [Development Guide](/docs/dev-guide.md)
+
+- [Api Documentation](https://rawcdn.githack.com/ServiceComb/service-center/master/docs/api-docs.html)
+
+- [Plug-in Extension](/server/plugin/README.md)
+
+#### [Docker Image Guide](/scripts/docker)
+
+- [Making Service-Center Image](/scripts/docker/build-image)
+
+- [Making Front-end Image](/scripts/docker/build-frontend-image)
+
+#### Deploy Service-Center Locally
+
+- [In Docker](/integration/docker)
+
+#### Deploy Service-Center Cluster
+
+- [In Kubernetes Cluster](/integration/k8s)
+
+- [In VM](/docs/sc-cluster.md)
+
+- [Deploy with TLS](/docs/security-tls.md)
+
+#### Monitoring Service-Center
+
+- [Integrate with Grafana](/docs/integration-grafana.md)
+
+#### [Contribution Guide](/docs/contribution.md)
\ No newline at end of file
diff --git a/service-center-reference/zh_CN/SUMMARY.md b/service-center-reference/zh_CN/SUMMARY.md
new file mode 100644
index 0000000..7eb8d2b
--- /dev/null
+++ b/service-center-reference/zh_CN/SUMMARY.md
@@ -0,0 +1,33 @@
+## 目录
+
+* [Design](/docs/design.md)
+
+* [Development Guide](/docs/dev-guide.md)
+
+ * [Api Documentation](https://rawcdn.githack.com/ServiceComb/service-center/master/docs/api-docs.html)
+
+ * [Plug-in Extension](/server/plugin/README.md)
+
+* [Docker Image Guide](/scripts/docker)
+
+ * [Making Service-Center Image](/scripts/docker/build-image)
+
+ * [Making Front-end Image](/scripts/docker/build-frontend-image)
+
+* Deploy Service-Center Locally
+
+ * [In Docker](/integration/docker)
+
+* Deploy Service-Center Cluster
+
+ * [In Kubernetes Cluster](/integration/k8s)
+
+ * [In VM](/docs/sc-cluster.md)
+
+ * [Deploy with TLS](/docs/security-tls.md)
+
+* Monitoring Service-Center
+
+ * [Integrate with Grafana](/docs/integration-grafana.md)
+
+* [Contribution Guide](/docs/contribution.md)
\ No newline at end of file
diff --git a/service-center-reference/zh_CN/api-docs.html b/service-center-reference/zh_CN/api-docs.html
new file mode 100644
index 0000000..3f221c5
--- /dev/null
+++ b/service-center-reference/zh_CN/api-docs.html
@@ -0,0 +1,3703 @@
+<!--
+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下线。 </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>
... 2183 lines suppressed ...