EndPoint 接口文档

1. 通用返回码说明

类型CODE说明
InternalServerErrorInternalServerError服务器内部错误
MissingParameterMissingParameter参数 %s 缺失
InvalidFormatInvalidFormat参数 %s 的格式非法
AlreadyExistAlreadyExist%s 已存在
CanNotFoundCanNotFound%s 不存在
OutOfBoundsOutOfBounds%s 超过限制
NoPermissionNoPermission无权限操作

Note

通用返回码后续可能会新增。

2. 接口说明

2.1 创建EndPoint

  • method && URL
METHODURL
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
         ]
     }
 ]
}

参数说明类型备注
EndpointNameEndpoint名称,由 1-24位小写字母、数字、或中划线组成,以字母开头,字母或数字结尾string必选
NamespaceId空间idlong必选
SubsetsSubset数组array必选
  • Subsets参数详细说明
参数说明类型备注
AddressesIP地址数组array必选
Ports端口数组,1~65535array必选
  • 返回

示例

{
 "EndpointId": 345345
}

参数说明类型备注
EndpointIdEndpoint idlong

2.2 查询endpoint列表

  • method && URL
METHODURL
GET/ncs?Version=2017-11-16&Action=DescribeEndpoints
  • 输入参数说明

示例

&NamespaceId=345345&Limit=10&Offset=20
参数说明类型备注
NamespaceId空间idlong必选
Limit查询数量大于0整数,默认20int非必选
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
EndpointsEndpoint列表,参见Endpoints参数详细说明array
  • Endpoints参数详细说明
参数说明类型备注
NameEndpoint namestring
NamespaceId空间idlong
EndpointIdEndpoint idlong
CreateAt创建时间StringISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z')
UpdateAt修改时间StringISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z')
SubsetsEndpoint的Subset数组array
  • Subsets参数详细说明
参数说明类型备注
AddressesIP地址数组array
Ports端口数组,1~65535array

2.3 查询所有空间endpoint列表

  • method && URL
METHODURL
GET/ncs?Version=2017-11-16&Action=DescribeEndpointsAllNamespaces
  • 输入参数说明

示例

&Limit=10&Offset=20
参数说明类型备注
Limit查询数量大于0整数,默认20int非必选
Offset列表偏移大等于0整数,默认0int非必选
  • 返回

示例

{
 "TotalCount": 1,
 "Endpoints": [
     {
         "Name": "ncsnd",
         "NamespaceId": 56456,
         "EndpointId": 253423,
             "CreateAt": 2342343,
             "UpdateAt": 3423423,
         "Subsets": [
             {
                 "Addresses": [
                     "10.55.48.26"
                 ],
                 "Ports": [
                     4000
                 ]
             }
         ]
     }
 ]
}
参数说明类型备注
TotalCount服务总数int
Endpointsendpoint列表,参见endpoints参数详细说明array
  • endpoints参数详细说明
参数说明类型备注
NameEndpoint namestring
NamespaceId空间idlong
EndpointIdEndpoint idlong
CreateAt创建时间,毫秒StringISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z')
UpdateAt修改时间,毫秒StringISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z')
SubsetsEndpoint的Subset数组array
  • Subsets参数详细说明
参数说明类型备注
AddressesIP地址数组array
Ports端口数组,1~65535array

2.4 查询endpoint

  • method && URL
METHODURL
GET/ncs?Version=2017-11-16&Action=DescribeEndpoint
  • 输入参数说明

示例

&NamespaceId=564321&EndpointId=787455
参数说明类型备注
NamespaceId空间idlong必选
EndpointIdEndpoint idlong必选
  • 返回

示例

{
"Endpoint": {
    "Name": "ncsnd",
    "NamespaceId": 564321,
    "EndpointId": 787455,
      "CreateAt": 345234,
      "UpdateAt": 345345,
    "Subsets": [
        {
            "Addresses": [
                "10.55.748.16"
            ],
            "Ports": [
                12300
            ]
        }
    ]
}
}
参数说明类型备注
EndpointEndpoint对象,参见endpoint参数详细说明object
  • endpoint参数详细说明
参数说明类型备注
NameEndpoint namestring
NamespaceId空间idlong
EndpointIdEndpoint idlong
CreateAt创建时间StringISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z')
UpdateAt修改时间StringISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z')
SubsetsEndpoint的Subset数组array
  • Subsets参数详细说明
参数说明类型备注
AddressesIP地址数组array
Ports端口数组,1~65535array

2.5 删除endpoint

  • method && URL
METHODURL
GET/ncs?Version=2017-11-16&Action=DeleteEndpoint
  • 输入参数说明

示例

&NamespaceId=456546&EndpointId=654231
参数说明类型备注
NamespaceId空间idlong必选
EndpointIdEndpoint idlong必选
  • 返回

示例

2.6 修改endpoint

  • method && URL
METHODURL
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空间idlong必选
EndpointIdEndpoint idlong必选
SubsetsSubsets数组array必选
  • Subsets参数详细说明
参数说明类型备注
AddressesIP地址数组array必选
Ports端口数组,1~65535array必选