CDN加速

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

查询命名空间下服务详情

更新时间:2019-08-16 13:05:30

适用产品:通用功能

接口描述

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

返回参数

JSON
参数名称类型描述
namestring服务名称
namespacestring命名空间名称。
imagestring镜像信息。格式为 “镜像仓库域名/仓库类型/{镜像名称}:{版本名称}”。
createTimestring服务创建时间。
updateTimestring服务更新时间。
cpufloat服务所需部署容器cpu规格。
memoryfloat服务所需部署容器内存规格。
statestring服务状态,服务状态详见服务状态说明。
availableZoneListarray容器部署可用区和数量信息
┗availableZonestring
┗countint
accessTypestring访问类型。访问类型有三种。分别为:公网访问:OUTER;内网访问:INNER;不提供访问:NONE
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生命周期停止前处理运行参数。
loadBalanceobject负载均衡信息。
┗namestring负载均衡名称。
┗cnamestringcname域名,此域名用于配置cname记录以在实际应用环境中访问。
┗sessionint会话保持。开启会话保持:1;不开启会话保持(即轮询):0。
┗forwardsarray公网映射关系。
┗┗portint公网访问端口,HTTP为80。
┗┗servicePortint服务端口。
┗┗uristringHTTP路径,改参数仅当protocol为HTTP时返回。
┗httpSchemaarrayHTTP请求检查,结构中具体字段见表-健康检查- HTTP请求检查参数。
┗initialDelaySecondsint延迟探测时间, 表示从容器启动后多久开始探测,默认为5s,最大不超过3600秒。
┗timeoutSecondsint超时时间,表示探测的超时等待时间,默认为1秒,最大不超过3600秒。
┗periodSecondsint探测周期,默认为10秒,最大不超过3600秒。。

错误码

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

示例

JSON
示例说明
json
请求示例
复制
#!/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-its.chinanetcenter.com/ecc/container/v1/namespace/test-openapi/appservices?limit=10&start=0&field=updateTime&direction=DESC&keyword=test-openapi&accessType=OUTER" \

-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
          }
        ],
        "accessType": "OUTER",
        "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": "",
        "loadBalance":{
          "name":"loadbalance1564970026",
          "cname":"test.app.ecc.wangsuedge.com",
          "protocol":"HTTP",
          "session":0,
          "forwards":[
            {
              "port":80,
              "servicePort":8082,
              "uri":"/a"
            },
            {
              "port":80,
              "servicePort":8083,
              "uri":"/b"
            }
          ]
        },
        "healthProbes": {
          "cmdSchema": {
            "cmd": "",
            "args": ""
          },
          "httpSchema": {
            "path": "/",
            "port": 80
          },
          "initialDelaySeconds": 5,
          "periodSeconds": 10,
          "timeoutSeconds": 1,
          "healthType": "http"
        }
      }      
  }