Querying Details About a Trigger
Function
This API is used to query the details about a trigger.
Constraints
None.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/webhook/policies/{policy_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
ID of an SWR Enterprise Edition instance. |
namespace_name |
Yes |
String |
Namespace name. |
policy_id |
Yes |
Integer |
Trigger ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Trigger ID. |
name |
String |
Trigger name. |
description |
String |
Trigger description. |
targets |
Array of Target objects |
Trigger target. |
event_types |
Array of strings |
Event type. |
enabled |
Boolean |
Whether to enable a policy. The value can be true or false. |
namespace_id |
Integer |
Namespace ID. |
namespace_name |
String |
Namespace name. |
creator |
String |
Creator. |
created_at |
String |
Creation time. |
updated_at |
String |
Update time. |
scope_rules |
Array of ScopeRule objects |
Application scope. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Trigger type. The value can be http. |
address |
String |
Trigger address, which cannot be changed. |
auth_header |
String |
Request header, in the format of key1:value1;key2:value2. |
skip_cert_verify |
Boolean |
Whether to skip certificate authentication. |
address_type |
String |
Trigger address type. The value can be internal (private network) or internet (public network). If the value is internal, private IP addresses must be used. |
Parameter |
Type |
Description |
---|---|---|
tag_selectors |
Array of RuleSelector objects |
Artifact tag selector. Currently, the value length must be 1. |
scope_selectors |
Map<String,Array<RuleSelector>> |
Artifact repository selector. Currently, only repository is supported, and the value length must be 1. |
repo_scope_mode |
String |
Repository selection method. The value can be regular or selection. regular is required for frontend display and optional for API calling. |
Parameter |
Type |
Description |
---|---|---|
kind |
String |
Matching type. Currently, doublestar is the only value. |
decoration |
String |
Selector matching type. The value can be repoMatches. |
pattern |
String |
Selector matching pattern. The maximum length is 512 characters. The regular expression can be nginx-* or {repo1, repo2}. *: matches any field that does not contain a slash (/). **: matches any field that contains a slash (/). ?: matches any single character except a slash (/). {option 1, option 2, ...}: matches any of the options. |
extras |
String |
Reserved field. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
Detailed rejection reason after encryption. You can call the API decode-authorization-message of STS to decrypt the reason. |
Example Requests
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/webhook/policies/{policy_id}
Example Responses
Status code: 200
The details about the trigger are queried successfully.
{ "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" : [ "PUSH_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 Sample Code
The SDK sample code is as follows.
Java
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 49 50 |
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 ShowInstanceWebhookSolution { 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(); ShowInstanceWebhookRequest request = new ShowInstanceWebhookRequest(); request.withInstanceId("{instance_id}"); request.withNamespaceName("{namespace_name}"); request.withPolicyId({policy_id}); try { ShowInstanceWebhookResponse response = client.showInstanceWebhook(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()); } } } |
Python
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 |
# 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 = ShowInstanceWebhookRequest() request.instance_id = "{instance_id}" request.namespace_name = "{namespace_name}" request.policy_id = {policy_id} response = client.show_instance_webhook(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 |
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.ShowInstanceWebhookRequest{} request.InstanceId = "{instance_id}" request.NamespaceName = "{namespace_name}" request.PolicyId = int32({policy_id}) response, err := client.ShowInstanceWebhook(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The details about the trigger are queried successfully. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
Access denied. |
404 |
Resource not found. |
500 |
Internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot