Query triggers with the DescribeTrigger API - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:DescribeTrigger

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request syntax

GET /clusters/{cluster_id}/triggers HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
cluster_id	string	Yes	The cluster ID.	c5cdf7e3938bc4f8eb0e44b21a80f****

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The namespace to which the application belongs.	default
Type	string	No	The type of trigger. Valid values: `deployment`: performs actions on Deployments. `application`: performs actions on applications that are deployed in Application Center. Default value: `deployment`. If you do not set this parameter, triggers are not filtered by type.	deployment
Name	string	Yes	The application name.	web-server
action	string	No	The action that the trigger performs. Set the value to redeploy. `redeploy`: redeploys the resources specified by `project_id`. If you do not specify this parameter, triggers are not filtered by action.	redeploy

Response elements

Element	Type	Description	Example
	array	The details of the triggers returned.
	object
id	string	The ID of the trigger.	75973497486******
name	string	The name of the trigger.	test
cluster_id	string	The ID of the associated cluster.	c259f563386444ebb8d7****
project_id	string	The name of the project. The name consists of the namespace where the application is deployed and the name of the application. The format is `${namespace}/${name}`. Example: default/test-app.	default/test-app
type	string	The type of trigger. Valid values: `deployment`: performs actions on Deployments. `application`: performs actions on applications that are deployed in Application Center. Default value: `deployment`.	deployment
action	string	The action that the trigger performs. The value is set to redeploy. `redeploy`: redeploys the resource specified by project_id.	redeploy
token	string	The token information.	eyJhbGci***

Examples

Success response

JSON format

[
  {
    "id": "75973497486******",
    "name": "test",
    "cluster_id": "c259f563386444ebb8d7****",
    "project_id": "default/test-app",
    "type": "deployment",
    "action": "redeploy",
    "token": "eyJhbGci***"
  }
]

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.