EndPoint 接口文档
1. 通用返回码说明
类型 | CODE | 说明 |
InternalServerError | InternalServerError | 服务器内部错误 |
MissingParameter | MissingParameter | 参数 %s 缺失 |
InvalidFormat | InvalidFormat | 参数 %s 的格式非法 |
AlreadyExist | AlreadyExist | %s 已存在 |
CanNotFound | CanNotFound | %s 不存在 |
OutOfBounds | OutOfBounds | %s 超过限制 |
NoPermission | NoPermission | 无权限操作 |
Note
通用返回码后续可能会新增。
2. 接口说明
2.1 创建EndPoint
METHOD | URL |
POST | /ncs?Version=2017-11-16&Action=CreateEndpoint |
示例
{
"EndpointName": "ncsnd",
"NamespaceId": 456546,
"Subsets": [
{
"Addresses": [
"10.55.748.14",
"48.78.63.458"
],
"Ports": [
12000,
12222
]
}
]
}
参数 | 说明 | 类型 | 备注 |
EndpointName | Endpoint名称,由 1-24位小写字母、数字、或中划线组成,以字母开头,字母或数字结尾 | string | 必选 |
NamespaceId | 空间id | long | 必选 |
Subsets | Subset数组 | array | 必选 |
参数 | 说明 | 类型 | 备注 |
Addresses | IP地址数组 | array | 必选 |
Ports | 端口数组,1~65535 | array | 必选 |
示例
{
"EndpointId": 345345
}
参数 | 说明 | 类型 | 备注 |
EndpointId | Endpoint id | long | |
2.2 查询endpoint列表
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DescribeEndpoints |
示例
&NamespaceId=345345&Limit=10&Offset=20
参数 | 说明 | 类型 | 备注 |
NamespaceId | 空间id | long | 必选 |
Limit | 查询数量大于0整数,默认20 | int | 非必选 |
Offset | 列表偏移大等于0整数,默认0 int | 非必选 | |
示例
{
"TotalCount": 1,
"Endpoints": [
{
"Name": "ncsnd",
"NamespaceId": 345345,
"EndpointId": 253423,
"CreateAt": 234234,
"UpdateAt": 979783,
"Subsets": [
{
"Addresses": [
"10.55.48.26"
],
"Ports": [
4000
]
}
]
}
]
}
参数 | 说明 | 类型 | 备注 |
TotalCount | 服务总数 | int | |
Endpoints | Endpoint列表,参见Endpoints参数详细说明 | array | |
参数 | 说明 | 类型 | 备注 |
Name | Endpoint name | string | |
NamespaceId | 空间id | long | |
EndpointId | Endpoint id | long | |
CreateAt | 创建时间 | String | ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
UpdateAt | 修改时间 | String | ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
Subsets | Endpoint的Subset数组 | array | |
参数 | 说明 | 类型 | 备注 |
Addresses | IP地址数组 | array | |
Ports | 端口数组,1~65535 | array | |
2.3 查询所有空间endpoint列表
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DescribeEndpointsAllNamespaces |
示例
&Limit=10&Offset=20
参数 | 说明 | 类型 | 备注 |
Limit | 查询数量大于0整数,默认20 | int | 非必选 |
Offset | 列表偏移大等于0整数,默认0 | int | 非必选 |
示例
{
"TotalCount": 1,
"Endpoints": [
{
"Name": "ncsnd",
"NamespaceId": 56456,
"EndpointId": 253423,
"CreateAt": 2342343,
"UpdateAt": 3423423,
"Subsets": [
{
"Addresses": [
"10.55.48.26"
],
"Ports": [
4000
]
}
]
}
]
}
参数 | 说明 | 类型 | 备注 |
TotalCount | 服务总数 | int | |
Endpoints | endpoint列表,参见endpoints参数详细说明 | array | |
参数 | 说明 | 类型 | 备注 |
Name | Endpoint name | string | |
NamespaceId | 空间id | long | |
EndpointId | Endpoint id | long | |
CreateAt | 创建时间,毫秒 | String | ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
UpdateAt | 修改时间,毫秒 | String | ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
Subsets | Endpoint的Subset数组 | array | |
参数 | 说明 | 类型 | 备注 |
Addresses | IP地址数组 | array | |
Ports | 端口数组,1~65535 | array | |
2.4 查询endpoint
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DescribeEndpoint |
示例
&NamespaceId=564321&EndpointId=787455
参数 | 说明 | 类型 | 备注 |
NamespaceId | 空间id | long | 必选 |
EndpointId | Endpoint id | long | 必选 |
示例
{
"Endpoint": {
"Name": "ncsnd",
"NamespaceId": 564321,
"EndpointId": 787455,
"CreateAt": 345234,
"UpdateAt": 345345,
"Subsets": [
{
"Addresses": [
"10.55.748.16"
],
"Ports": [
12300
]
}
]
}
}
参数 | 说明 | 类型 | 备注 |
Endpoint | Endpoint对象,参见endpoint参数详细说明 | object | |
参数 | 说明 | 类型 | 备注 |
Name | Endpoint name | string | |
NamespaceId | 空间id | long | |
EndpointId | Endpoint id | long | |
CreateAt | 创建时间 | String | ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
UpdateAt | 修改时间 | String | ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') |
Subsets | Endpoint的Subset数组 | array | |
参数 | 说明 | 类型 | 备注 |
Addresses | IP地址数组 | array | |
Ports | 端口数组,1~65535 | array | |
2.5 删除endpoint
METHOD | URL |
GET | /ncs?Version=2017-11-16&Action=DeleteEndpoint |
示例
&NamespaceId=456546&EndpointId=654231
参数 | 说明 | 类型 | 备注 |
NamespaceId | 空间id | long | 必选 |
EndpointId | Endpoint id | long | 必选 |
示例
2.6 修改endpoint
METHOD | URL |
POST | /ncs?Version=2017-11-16&Action=ModifyEndpoint |
示例
{
"NamespaceId": 456546,
"EndpointId": 456432,
"Subsets": [
{
"Addresses": [
"10.55.748.14",
"48.78.63.458"
],
"Ports": [
12000,
12222
]
}
]
}
参数 | 说明 | 类型 | 备注 |
NamespaceId | 空间id | long | 必选 |
EndpointId | Endpoint id | long | 必选 |
Subsets | Subsets数组 | array | 必选 |
参数 | 说明 | 类型 | 备注 |
Addresses | IP地址数组 | array | 必选 |
Ports | 端口数组,1~65535 | array | 必选 |