Namespace 接口文档
1. 通用返回码说明
| 类型 | CODE | MESSAGE | 说明 |
|---|
| InternalServerError | InternalServerError | 服务器内部错误 | 服务器内部错误 |
| MissingParameterName | MissingParameter | 参数 %s 缺失 | Namespace名称缺失 |
| InvalidFormatName | InvalidFormat | 参数 %s 的格式非法 | Namespace名称不可用 |
| NameAlreadyExist | AlreadyExist | %名称已存在 | Namespace名称已存在 |
| QuotaInsufficient | QuotaInsufficient | %配额不足 | Namespace配额不足 |
| CanNotDeleteNamespace | CanNotDelete | 此%s不能删除 | Namespace下有service,不能删除 |
| CanNotFoundNamespace | CanNotFound | 找不到对应%s | Namespace找不到 |
2. 接口说明
2.1 创建Namespace
| METHOD | URL |
|---|
| GET | /ncs?Version=2017-11-16&Action=CreateNamespace |
GET /ncs?Version=2017-11-16&Action=CreateNamespace&Namespace=namespacetest
| 参数 | 类型 | 说明 | 备注 |
|---|
| Namespace | String | namespace名称 | 无 |
{
"NamespaceId": 1
}
| 参数 | 类型 | 说明 | 备注 |
|---|
| NamespaceId | long | Namespace表主键 | 无 |
2.2 删除Namespace
| METHOD | URL |
|---|
| GET | /ncs?Version=2017-11-16&Action=DeleteNamespace |
GET /ncs?Version=2017-11-16&Action=DeleteNamespace&NamespaceId=1
| 参数 | 类型 | 说明 | 备注 |
|---|
| NamespaceId | long | Namespace表主键 | 无 |
无
根据Http Status code判断删除成功与否。
2.3 获取Namespace列表
| METHOD | URL |
|---|
| GET | /ncs?Version=2017-11-16&Action=DescribeNamespaces |
GET /ncs?Version=2017-11-16&Action=DescribeNamespaces
[{
"NamespaceId": 1,
"Name": "test",
"CreateAt": 12345,
"NamespaceFullName": "test-accout"
}]
| 参数 | 类型 | 说明 | 备注 |
|---|
| NamespaceId | long | Namespace表主键 | 无 |
| Name | String | Namespace名称 | 无 |
| CreateAt | String | 创建时间 | ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
| NamespaceFullName | String | Namespace全名 | 无 |
