github.com/XiaoMi/Gaea@v1.2.5/docs/gaea-cc.md (about)

     1  ## 1. listNamespace
     2  
     3  - 方法描述：查询该集群下的namespace 列表
     4  - URL地址：/api/cc/namespace/list
     5  - 请求方式：get
     6  - 请求参数：
     7  
     8  | 字段    | 类型   | 说明     | 是否必传 |
     9  | :------ | :----- | :------- | :------- |
    10  | cluster | string | 集群名称 | Y        |
    11  
    12  
    13  
    14  - 返回参数
    15  
    16  | 字段                    | 类型      | 说明     | json key    |
    17  | :---------------------- | :-------- | :------- | :---------- |
    18  | RetHeader               | RetHeader | 返回头   | ret_header  |
    19  | Data                    | string[]  | 返回值   | data        |
    20  | 此后为RetHeader对应字段 |           |          |             |
    21  | RetCode                 | int       | 返回码   | ret_code    |
    22  | RetMessage              | string    | 返回信息 | ret_message |
    23  
    24  
    25  
    26  ## 2.queryNamespace (弃用)
    27  
    28  ## 3.detailNamespacce
    29  
    30  - 方法描述：查询namespace的详细配置
    31  - URL地址：/api/cc/namespace/detail/:name
    32  - 请求方式：get
    33  - 请求参数：
    34  
    35  | 字段    | 类型   | 说明                  | 是否必传 |
    36  | :------ | :----- | :-------------------- | :------- |
    37  | name    | string | 一次查询一个namespace | Y        |
    38  | cluster | string |                       | Y        |
    39  
    40  
    41  
    42  - 返回参数
    43  
    44  | 字段                    | 类型        | 说明     | json key    |
    45  | :---------------------- | :---------- | :------- | :---------- |
    46  | RetHeader               | RetHeader   | 返回头   | ret_header  |
    47  | Data                    | Namespace[] | 返回值   | data        |
    48  | 此后为RetHeader对应字段 |             |          |             |
    49  | RetCode                 | int         | 返回码   | ret_code    |
    50  | RetMessage              | string      | 返回信息 | ret_message |
    51  
    52  Namespace结构参考：https://github.com/XiaoMi/Gaea/blob/master/docs/configuration.md
    53  
    54  ## 4.modifyNamespace
    55  
    56  - 方法描述：修改namespace配置
    57  - URL地址：/api/cc/namespace/modify
    58  - 请求方式：put
    59  - 请求参数
    60  
    61  | 字段      | 类型      | 说明                        | 是否必传 |
    62  | :-------- | :-------- | :-------------------------- | :------- |
    63  | cluster   | string    |                             | Y        |
    64  
    65  - 请求body
    66  
    67  | 字段      | 类型      | 说明                           | 是否必传 |
    68  | :-------- | :-------- | :--------------------------    | :------- |
    69  | namespace | json      | 在body中传递namespace的配置信息 | Y        |
    70  
    71  Namespace结构参考：https://github.com/XiaoMi/Gaea/blob/master/docs/configuration.md
    72  
    73  - 返回参数
    74  
    75  | 字段       | 类型   | 说明     | json key    |
    76  | :--------- | :----- | :------- | :---------- |
    77  | RetCode    | int    | 返回码   | ret_code    |
    78  | RetMessage | string | 返回信息 | ret_message |
    79  
    80  
    81  
    82  ## 5.delNamespace
    83  
    84  - 方法描述：删除namespace 
    85  - URL地址：/api/cc/namespace/delete/:name
    86  - 请求方式：put
    87  - 请求参数
    88  
    89  | 字段    | 类型   | 说明                  | 是否必传 |
    90  | :------ | :----- | :-------------------- | :------- |
    91  | name    | string | 一次删除一个namespace | Y        |
    92  | cluster | string |                       | Y        |
    93  
    94  
    95  
    96  - 返回参数
    97  
    98  | 字段       | 类型   | 说明     | json key    |
    99  | :--------- | :----- | :------- | :---------- |
   100  | RetCode    | int    | 返回码   | ret_code    |
   101  | RetMessage | string | 返回信息 | ret_message |
   102  
   103  
   104  
   105  ## 6.sqlFingerprint
   106  
   107  - 方法描述：获取慢sql , 错误sql 指纹
   108  - URL地址：/api/cc/namespace/sqlfingerprint/:name
   109  - 请求方式：get
   110  - 请求参数
   111  
   112  | 字段    | 类型   | 说明          | 是否必传 |
   113  | :------ | :----- | :------------ | :------- |
   114  | name    | string | namespace名称 | Y        |
   115  | cluster | string | 集群名称      | Y        |
   116  
   117  
   118  
   119  - 返回参数
   120  
   121  | 字段                    | 类型              | 说明     | json key    |
   122  | :---------------------- | :---------------- | :------- | :---------- |
   123  | RetHeader               | RetHeader         | 返回头   | ret_header  |
   124  | ErrSQLs                 | map[string]string |          | err_sqls    |
   125  | SlowSQLs                | map[string]string |          | slow_sqls   |
   126  | 此后为RetHeader对应字段 |                   |          |             |
   127  | RetCode                 | int               | 返回码   | ret_code    |
   128  | RetMessage              | string            | 返回信息 | ret_message |
   129  
   130  
   131  
   132  ## 7.proxyConfigFingerprint
   133  
   134  - 方法描述：获取该集群下所有proxy配置的md5值
   135  - URL地址：/api/cc/proxy/config/fingerprint
   136  - 请求方式：get
   137  - 请求参数
   138  
   139  | 字段    | 类型   | 说明 | 是否必传 |
   140  | :------ | :----- | :--- | :------- |
   141  | cluster | string |      | Y        |
   142  
   143  
   144  
   145  - 返回参数
   146  
   147  | 字段                    | 类型              | 说明                                  | json key    |
   148  | :---------------------- | :---------------- | :------------------------------------ | :---------- |
   149  | RetHeader               | RetHeader         | 返回头                                | ret_header  |
   150  | Data                    | map[string]string | key: proxy-ip:portvalue:md5 of config | data        |
   151  | 此后为RetHeader对应字段 |                   |                                       |             |
   152  | RetCode                 | int               | 返回码                                | ret_code    |
   153  | RetMessage              | string            | 返回信息                              | ret_message |