CDN加速

文档中心 API文档 工具服务 查询命名空间下单个Deployment详情

查询命名空间下单个Deployment详情

更新时间:2020-04-20 15:47:02
适用产品:通用功能

接口描述

查询指定命名空间下指定Deployment的详情

请求参数

参数名称类型必填描述
limitint每页返回容器个数,默认为10
startint起始页位置,默认为0
fieldstring根据指定参数对返回容器进行排序,支持排序参数有:createTime; updateTimes
directionstring排序方向,升序为ASC,降序为DESC

返回参数

参数名称类型描述
namestring服务名称
namespacestring命名空间名称。
imagestring镜像信息。格式为 “镜像仓库域名/仓库类型/{镜像名称}:{版本名称}”。
createTimestring服务创建时间。
updateTimestring服务更新时间。
cpufloat服务所需部署容器cpu规格。
memoryfloat服务所需部署容器内存规格。
statestring服务状态,服务状态详见服务状态说明。
availableZoneListarray容器部署可用区和数量信息
┗availableZonestring可用区英文名称,一次允许最多添加50个可用区。
┗countint可用区部署容器个数,单可用区最多允许添加50个容器。
serviceAliasstring内网服务别名。
portsarray集群内部访问端口映射信息
┗protocolstring服务端口协议,包括TCP和UDP两种协议,最多允许添加50条端口映射。 公网访问协议,包括HTTP、TCP和UDP。
┗containerPortint容器端口,端口范围为1-65535。
┗servicePortint服务端口,端口范围为1-65535。
restartStrategystring重启策略,当前仅支持总是(ALWAYS)。默认为ALWAYS。
expectInstanceNumint预期运行容器数。
runningInstanceNumint当前正常运行容器数。
environmentsmap环境变量映射关系,格式为{变量名}:{变量值}。
runPathstring启动命令运行路径。
startCmdstring启动命令运行命令。
startCmdArgsstring启动命令运行参数。
postStartCmdstring生命周期启动后处理运行命令。
postStartCmdArgsstring生命周期启动后处理运行参数。
preStopCmdstring生命周期停止前处理运行命令。
preStopCmdArgsstring生命周期停止前处理运行参数。
healthProbesobject健康检查,详见表-健康检查结构。
┗healthTypeint健康检查探针类型,类型包括两种: 执行命令检查:sh HTTP请求检查:http
┗cmdSchemaarray执行命令检查,结构中具体字段见表-健康检查-执行命令检查参数。
┗┗cmdstring执行命令检查所需运行命令,长度不超过1024个字符。
┗┗argsstring执行命令检查运行命令所需运行参数,长度不超过1024个字符。
┗httpSchemaarrayHTTP请求检查,结构中具体字段见表-健康检查- HTTP请求检查参数。
┗┗portintHTTP请求检查容器端口,端口号范围1-65535
┗┗pathstringHTTP请求检查URL路径,以/开头,支持大小写字母数字和!'()*-._~,长度不超过100个字符。
┗initialDelaySecondsint延迟探测时间, 表示从容器启动后多久开始探测,默认为5s,最大不超过3600秒。
┗timeoutSecondsint超时时间,表示探测的超时等待时间,默认为1秒,最大不超过3600秒。
┗periodSecondsint探测周期,默认为10秒,最大不超过3600秒。。

错误码

错误代码(code)描述(message)HTTP状态码语义
31442001request format error400请求格式错误
31442002missing argument400缺少必要参数
31442003illegal argument400参数非法

示例

示例说明
请求示例
复制
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/ecc/openapi /v1/namespace/test-openapi/workload/deployment/test-opensvc-000" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json"
返回示例
复制
{
  "code": "0",
  "message": "success",
  "data": {
      "name": "test-opensvc-000",
      "namespace": "test-openapi",
      "createTime": "2019-07-22 16:04:17",
      "updateTime": "2019-07-22 16:07:44",
      "image": "ecchub.wangsuedge.com/guest/testimage-x86",
      "cpu": 1,
      "memory": 2,
      "state": "RUNNING",
      "availableZoneList": [
        {
          "availableZone": "HB-wuhan3-CK",
          "count": 2
        }
      ],
      "serviceAlias": "test-opensvc-000",
      "ports": [
        {
          "protocol": "TCP",
          "containerPort": 80,
          "servicePort": 8080
        }
      ],
      "restartStrategy": "Always",
      "expectInstanceNum": 1,
      "runningInstanceNum": 1,
      "environments": {
        "TEST_ENV": "test"
      },
      "runPath": "",
      "logAbsPaths": [
        {
          "logPath": "stdout"
        }
      ],
      "startCmd": "",
      "startCmdArgs": "",
      "postStartCmd": "touch 4544",
      "postStartCmdArgs": "",
      "preStopCmd": "",
      "preStopCmdArgs": "",
      "healthProbes": {
        "cmdSchema": {
          "cmd": "",
          "args": ""
        },
        "httpSchema": {
          "path": "/",
          "port": 80
        },
        "initialDelaySeconds": 5,
        "periodSeconds": 10,
        "timeoutSeconds": 1,
        "healthType": "http"
      }
    }      
}