All Products
Search
Document Center

Container Service for Kubernetes:DescribeTrigger

Last Updated:Feb 29, 2024

You can call the DescribeTrigger operation to query triggers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeTriggerRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

GET /clusters/[cluster_id]/triggers

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringYes

The cluster ID.

c5cdf7e3938bc4f8eb0e44b21a80f****
NamespacestringYes

The namespace to which the application belongs.

default
TypestringNo

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
NamestringYes

The application name.

web-server
actionstringNo

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 parameters

ParameterTypeDescriptionExample
object []

The details of the triggers returned.

idstring

The ID of the trigger.

1234
namestring

The name of the trigger.

test
cluster_idstring

The ID of the associated cluster.

c259f563386444ebb8d7****
project_idstring

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
typestring

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
actionstring

The action that the trigger performs. The value is set to redeploy.

redeploy: redeploys the resource specified by project_id.

redeploy
tokenstring

The token information.

eyJhbGci***

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-05-29The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.