获取触发器-容器服务-文档中心-腾讯云

说明：

当前页面接口为旧版 API，未来可能停止维护。容器服务 API 3.0 版本接口定义更加规范，访问时延下降显著，建议使用容器服务 API 3.0。

1. 接口描述

本接口 ( ListTrigger ) 获取触发器。
接口请求域名：ccr.api.qcloud.com。

2. 输入参数

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

参数名称	描述	类型	必选
triggerName	如果要获取某个触发器的详情，可以指定该参数。精确匹配查找。	String	否
offset	数据偏移量，默认值为 0	Int	否
limit	返回数据条数，默认为 20	Int	否
reponame	用于查询 bind 某个具体仓库的触发器。精确匹配查找。	String	否

3. 输出参数

参数名称	描述	类型
code	公共错误码。0 表示成功，其他值表示失败	Int
codeDesc	业务侧错误码。成功时返回 Success，错误时返回具体业务错误原因	String
message	模块错误信息描述，与接口相关	String
totalCount	查询结果数目	Int
triggerInfo	触发器信息字段	Object Array

触发器信息字段：

参数名称	描述	类型
triggerName	要更新的触发器名称	String
repoName	触发器绑定的仓库名	String
invokeSource	触发原因。当前为固定值“IMAGE_PUSH”，表示由镜像推送引起触发	String
invokeAction	触发动作。当前为固定值“SERVICE_UPDATE”，表示更新服务	String
createTime	触发器创建时间	String
updateTime	触发器更新时间	String
invokeCondition	触发条件	Object
invokePara	触发参数	Object

invokeCondition参数包括以下字段：

参数名称	描述	类型
invokeMethod	触发方式。 all：全部触发 taglist：指定tag触发 regex：正则表达式触发	String
invokeExpr	触发方式对应的表达式。 invokeMethod为“all”时，此参数为空 invodeMethod为“taglist”时，此参数为 tag 列表，英文分号分隔，如：v1;v2;v3 invokeMethod为“regex”时，此参数为正则表达式，如：^test*	String

invokePara参数包括以下字段：

参数名称	描述	类型
serviceName	更新服务参数服务名称	String
clusterId	更新服务参数集群 ID	String
namespace	更新服务参数命名空间	String
containerName	更新服务参数容器名称	String
clusterRegion	更新服务参数集群区域。地域编号如下： 1：广州 4：上海 5：中国香港 7：上海金融 8：北京 9：新加坡 16：成都	Int

4. 示例

输入

  https://domain/v2/index.php?Action=ListTrigger
  &triggerName=trigger_test
  &offset=0
  &limit=20
  &reponame=test/kube_test
  &其它公共参数

输出

{
    "code": 0,
    "message": "", 
    "codeDesc": "Success",
    "data": {
        "totalCount": 1,
        "triggerInfo": [
            {
                "triggerName": "trigger_test",
                "invokeSource": "IMAGE_PUSH",
                "invokeAction": "SERVICE_UPDATE",
                "repoName": "test/kube_test",
                "createTime": "2018-03-07 14:30:43",
                "updateTime": "2018-03-08 15:30:43",
                "invokeCondition": {
                    "invokeMethod": "all",
                    "invokeExpr": ""
                },
                "invokePara": {
                    "appId": "1254666666",
                    "clusterId": "cls-xxxxxxxx",
                    "namespace": "default",
                    "serviceName": "nginx-test",
                    "containerName": "nginx-test",
                    "clusterRegion": 1
                }
            }
        ]
    }
}

获取触发器

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例