tencent cloud

APIs

DocumentaçãoAPIsTencent Cloud Agent Development PlatformScheduled Task APIsDescribeAppTriggerInstance

DescribeAppTriggerInstance

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-11-04 21:48:54

1. API Description

Domain name for API request: adp.intl.tencentcloudapi.com.

DescribeAppTriggerInstance

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeAppTriggerInstance.
Version Yes String Common Params. The value used for this API: 2026-05-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
AppId No String

Application ID.
InstanceId No String

Trigger running instance ID.
Scope No Integer
Enumeration item Enumeration value Description
APP_TRIGGER_SCOPE_UNSPECIFIED 0 Unspecified
APP_TRIGGER_SCOPE_APP 1 B-end admin
APP_TRIGGER_SCOPE_USER 2 C-end visitor
UserId No String

Visitor ID.

3. Output Parameters

Parameter Name Type Description
Instance AppTriggerInstance

Application trigger instance
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Success

Input Example

POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAppTriggerInstance
<Common request parameters>

{
    "AppId": "2072866150944382336",
    "InstanceId": "2e41cd4a-39cc-455e-a530-8a543db8ac13",
    "UserId": "cuiyo******"
}

Output Example

{
    "Response": {
        "Instance": {
            "AppId": "2072866150944382336",
            "ConversationId": "t2e41cd4a39cc455ea5308a543db8ac13",
            "CreatedAt": "2026-07-03T10:41:24+08:00",
            "FinishedAt": "2026-07-03T10:41:44+08:00",
            "InstanceId": "2e41cd4a-39cc-455e-a530-8a543db8ac13",
            "RequestId": "trigger_2e41cd4a-39cc-455e-a530-8a543db8ac13",
            "ResultCode": "SUCCESS",
"ResultSummary": "Execute the `hello` workflow every 1 minute. The corresponding **cron expression** is:\n\n
\n* * * * \n

\n\nMeaning of each field (from left to right):\n\n| Field | Value | Meaning |\n|------|------|------|\n| Minute | `*` | Every minute |\n| Hour | `*` | Every hour |\n| Day | `*` | Every day |\n| Month | `*` | Every month |\n| Week | `*` | Any day of the week |\n\n---\n\n**Common platform setting methods:**\n\n**1. Linux crontab**\n

bash\n * * * * /path/to/hello_workflow.sh\n

\n\n**2. GitHub Actions**\n

yaml\non:\n schedule:\n - cron: '* * * * '\n

\n\n**3. Kubernetes CronJob**\n

yaml\nspec:\n schedule: ' * * * *'\n jobTemplate:\n spec:\n template:\n spec:\n containers:\n - name: hello\n image: your-image\n command: ["./hello_workflow"]\n

\n\n**4. Airflow DAG**\n

python\nfrom airflow import DAG\nfrom airflow.operators.bash import BashOperator\nfrom datetime import timedelta\n\ndefault_args = {\n 'start_date': datetime(2026, 7, 3),\n}\n\nwith DAG('hello_workflow',\n schedule_interval=timedelta(minut
"RunId": "msg_a2583256-5c07-4e38-8992-6b49daf00d41_1",
"Source": 1,
"StartedAt": "2026-07-03T10:41:24+08:00",
"Status": 4,
"TraceId": "121b84421b74a353eba6a0a793232925 / rcd_a2583256-5c07-4e38-8992-6b49daf00d41",
"TriggerId": "64201696-52ee-49f6-a95b-0773b60a8e6b",
"WorkflowRunId": ""
},
"RequestId": "d32dd79b-5346-4cbe-8d0e-dd789a986116"
}
}


## 5. Developer Resources

### SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
* [Tencent Cloud SDK 3.0 for Python](https://github.com/TencentCloud/tencentcloud-sdk-python-intl-en/blob/master/tencentcloud/adp/v20260520/adp_client.py)
* [Tencent Cloud SDK 3.0 for Java](https://github.com/TencentCloud/tencentcloud-sdk-java-intl-en/blob/master/src/main/java/com/tencentcloudapi/adp/v20260520/AdpClient.java)
* [Tencent Cloud SDK 3.0 for PHP](https://github.com/TencentCloud/tencentcloud-sdk-php-intl-en/blob/master/src/TencentCloud/Adp/V20260520/AdpClient.php)
* [Tencent Cloud SDK 3.0 for Go](https://github.com/TencentCloud/tencentcloud-sdk-go-intl-en/blob/master/tencentcloud/adp/v20260520/client.go)
* [Tencent Cloud SDK 3.0 for Node.js](https://github.com/TencentCloud/tencentcloud-sdk-nodejs-intl-en/blob/master/tencentcloud/adp/v20260520/adp_client.js)
* [Tencent Cloud SDK 3.0 for .NET](https://github.com/TencentCloud/tencentcloud-sdk-dotnet-intl-en/blob/master/TencentCloud/Adp/V20260520/AdpClient.cs)
* [Tencent Cloud SDK 3.0 for C++](https://github.com/TencentCloud/tencentcloud-sdk-cpp-intl-en/blob/master/adp/src/v20260520/AdpClient.cpp)

### Command Line Interface

* [Tencent Cloud CLI 3.0](https://www.tencentcloud.com/document/product/1013/33463)

## 6. Error Code

There is no error code related to the API business logic. For other error codes, please see [Common Error Codes](https://www.tencentcloud.com/document/api/1254/85466#Common-Error-Codes).

Anterior: DescribeAppTriggerPróximo: DescribeAppTriggerRunLogList

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation