获取触发器列表
功能介绍
获取触发器列表
接口约束
无
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/webhook/policies
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
instance_id |
是 |
String |
企业仓库实例ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
order_column |
否 |
String |
排序字段,支持created_at、updated_at、name,默认为created_at |
order_type |
否 |
String |
排序方式,支持desc、asc,默认desc;order_type需要与order_column配合使用 |
name |
否 |
String |
策略名称,模糊查询 |
namespace_id |
否 |
Integer |
所属命名空间ID |
offset |
否 |
Integer |
起始索引,默认值为0。注意:offset和limit参数需要配套使用,offset必须为0或者为limit的倍数。 |
limit |
否 |
Integer |
返回条数,默认为10,最大值为100。注意:offset和limit参数需要配套使用,offset必须为0或者为limit的倍数。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
policies |
Array of WebhookPolicyDetail objects |
触发器列表 |
total |
Integer |
触发器总数 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
触发器ID |
name |
String |
触发器名称 |
description |
String |
触发器描述 |
targets |
Array of Target objects |
触发目标 |
event_types |
Array of strings |
事件类型 |
enabled |
Boolean |
是否启用,可选true或false |
namespace_id |
Integer |
命名空间ID |
namespace_name |
String |
命名空间名 |
creator |
String |
创建者 |
created_at |
String |
创建时间 |
updated_at |
String |
更新时间 |
scope_rules |
Array of ScopeRule objects |
触发作用范围规则 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
触发类型,可选http |
address |
String |
触发地址,不可修改 |
auth_header |
String |
请求头,格式为key1:value1;key2:value2 |
skip_cert_verify |
Boolean |
是否跳过证书认证 |
address_type |
String |
触发地址类型,可选internal(内网),internet(公网)。internal必须为内网ip形式。 |
参数 |
参数类型 |
描述 |
---|---|---|
tag_selectors |
Array of RuleSelector objects |
制品版本选择器,目前只支持长度为1 |
scope_selectors |
Map<String,Array<RuleSelector>> |
制品仓库选择器,目前只支持repository且长度为1 |
repo_scope_mode |
String |
repository选择方式。可选regular、selection,前端显示需要,api调用时可选regular |
参数 |
参数类型 |
描述 |
---|---|---|
kind |
String |
匹配类型,目前只支持doublestar |
decoration |
String |
选择器匹配类型,当前支持repoMatches |
pattern |
String |
选择器匹配样式,最大长度512。支持正则表达式,正则表达式规则可填写如 nginx-* ,{repo1,repo2} 等,其中:
**:匹配包含 '/' 的任何字段。 ? :匹配任何单个非 '/' 的字符。 {选项1,选项2,...}:同时匹配多个选项。 |
extras |
String |
预留字段 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/webhook/policies
响应示例
状态码:200
查询触发器列表成功
{ "total" : 1, "policies" : [ { "id" : 39, "name" : "te3st123", "description" : "", "namespace_id" : 1, "targets" : [ { "type" : "http", "address" : "https://baidu.com", "auth_header" : "key:value", "skip_cert_verify" : false, "address_type" : "internet" } ], "event_types" : [ "DELETE_ARTIFACT" ], "creator" : "admin", "created_at" : "2021-02-18T12:05:36.218939Z ", "updated_at" : "2021-02-18T12:05:36.218939Z", "enabled" : true, "namespace_name" : "library", "scope_rules" : [ { "repo_scope_mode" : "regular", "tag_selectors" : [ { "kind" : "doublestar", "decoration" : "matches", "pattern" : "**", "extras" : "" } ], "scope_selectors" : { "repository" : [ { "kind" : "doublestar", "decoration" : "repoMatches", "pattern" : "**", "extras" : "" } ] } } ] } ] }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.swr.v2.region.SwrRegion; import com.huaweicloud.sdk.swr.v2.*; import com.huaweicloud.sdk.swr.v2.model.*; public class ListInstanceWebhooksSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SwrClient client = SwrClient.newBuilder() .withCredential(auth) .withRegion(SwrRegion.valueOf("<YOUR REGION>")) .build(); ListInstanceWebhooksRequest request = new ListInstanceWebhooksRequest(); request.withInstanceId("{instance_id}"); try { ListInstanceWebhooksResponse response = client.listInstanceWebhooks(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkswr.v2.region.swr_region import SwrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkswr.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SwrClient.new_builder() \ .with_credentials(credentials) \ .with_region(SwrRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListInstanceWebhooksRequest() request.instance_id = "{instance_id}" response = client.list_instance_webhooks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := swr.NewSwrClient( swr.SwrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListInstanceWebhooksRequest{} request.InstanceId = "{instance_id}" response, err := client.ListInstanceWebhooks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询触发器列表成功 |
400 |
错误的请求 |
401 |
鉴权失败 |
403 |
禁止访问 |
404 |
未找到资源 |
500 |
内部错误 |
错误码
请参见错误码。