文档平台 API 中心 容器服务 服务相关接口 获取服务的 yaml 文本信息

获取服务的 yaml 文本信息

最近更新时间:2018-06-01 21:27:36

接口描述

本接口(DescribeClusterServiceText)用于获取服务的文本信息。

接口请求域名:

ccs.api.qcloud.com

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数

参数名称 描述 类型 必选
clusterId 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段 String
serviceName 服务名,服务名称由小写字母、数字和-组成,由小写字母开头,小写字母或数字结尾, 且长度不超过 63 个字符 String
namespace 命名空间,请填写 查询集群命名空间 接口中返回的 namespaces 字段,默认为 default String
bSimple 是否使用删减不必要字段的 yaml Int

输出参数

参数名称 描述 类型
code 公共错误码。0 表示成功,其他值表示失败 Int
codeDesc 业务错误码。成功时返回 Success,错误时返回具体业务错误原因 String
message 模块错误信息描述,与接口相关 String
serviceText yaml 配置详情完整版文本 String
servicePureText yaml 配置详情纯净版文本 String

示例

输入

 https://domain/v2/index.php?Action=DescribeClusterServiceText
  &clusterId=cls-xxxxx
  &namespace=default
  &serviceName=nginx
  &其它公共参数

输出

{
    "data":{
        "code":0,
        "message":"",
        "codeDesc":"Success",
        "data":{
            "serviceText":"xxxxxyaml详情完整版",
            "servicePureText": "xxxxxyaml详情纯净版"
        }
    },
    "message":"",
    "code":0
}