容器接口文档

1. 通用返回码说明

类型CODE说明
SuccessSuccess成功时返回
InternalServerErrorInternalServerError服务器内部错误
MissingParameterMissingParameter参数xxx缺失
InvalidParameterValueInvalidParameterValue值 xxx 对于参数 xxx 无效

Note

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

2. 接口说明

2.1 容器保存为镜像

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

示例

ContainerId=111&RepositoryName=test&Tag=test
参数类型说明备注是否必填
ContainerIdLong容器id
RepositoryNameString镜像仓库名支持多级目录
TagString镜像版本
  • 返回

2.2 查询容器日志

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

示例

 PodId=2985&LogFilePosition=beginning&OffsetFrom=-4237&OffsetTo=-4137&ReferenceLineNum=-1&ReferenceTimestamp=2018-02-03T17:29:20.855299194Z&NamespaceId=2201
参数类型说明备注是否必填
NamespaceIdLong空间id
PodIdLongpod的id
ContainerNameString容器名称如果Pod仅有一个容器,可以不填,如果有多个容器,必须指定容器名
Previousbool是否查询上个已退出容器日志 默认为false,查询当前的容器日志
LogFilePositionString只能填写beginning或者end如果是请求最早的日志,为beginning,最新的为end,上下翻页填写上次请求返回的值
OffsetFromint偏移参数请求最早日志为-2000000100,最新的为2000000000,翻页填写上次请求中的selection.offsetFrom值
OffsetToint偏移参数请求最早日志为-2000000000,最新的为2000000100,翻页填写上次请求中的selection.offsetTo值
ReferenceLineNumint请求最早日志为0,最新的为0,翻页填写上次请求中的selection.referencePoint.lineNum值
ReferenceTimestampString请求最早日志为oldest,最新的为newest,翻页填写上次请求中的selection.referencePoint.logTimestamp值
  • 返回
{
    "RequestId": "bb343f57-5b21-4e2c-9f63-47ef1727b3c0",
    "selection": {
        "logFilePosition": "beginning",
        "offsetFrom": -4237,
        "offsetTo": -4137,
        "referencePoint": {
            "lineNum": -1,
            "logTimestamp": "2018-02-03T17:29:20.855299194Z"
        }
    },
    "logs": [
        {
            "content": "Sun Feb 4 00:18:34 CST 2018",
            "timestamp": "2018-02-03T16:18:34.891142011Z"
        },
        {
            "content": "Sun Feb 4 00:18:35 CST 2018",
            "timestamp": "2018-02-03T16:18:35.892696129Z"
        }
    ],
    "info": {
        "fromDate": "2018-02-03T16:18:34.891142011Z",
        "podName": "tomcatlog-1539-5448",
        "toDate": "2018-02-03T16:20:14.095981277Z",
        "truncated": false
    }
}