DescribeStreamIngest
1. API Description
Domain name for API request: trtc.tencentcloudapi.com.
You can query the status of the Relay task.
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: DescribeStreamIngest. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-jakarta, ap-mumbai, ap-singapore. |
| SdkAppId | Yes | Integer | The SDKAppId of TRTC should be the same as the SDKAppId corresponding to the task room. |
| TaskId | Yes | String | The unique Id of the task, will return after successfully starting the task. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Status | String | Task status information. InProgress: Indicates that the current task is in progress. NotExist: Indicates that the current task does not exist. Example value: InProgress |
| 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 Query Task
Query the status of the Relay Task with TaskId 1234 under SdkAppId 1234567890
Input Example
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamIngest
<Common request parameters>
{
"SdkAppId": 1234567890,
"TaskId": "1234"
}
Output Example
{
"Response": {
"Status": "InProgress",
"RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.QueryTaskInfoFailed | Query task failed |
| InternalError.DBError | An error occurred while querying the database. |
| InvalidParameter.TaskId | TaskId parameter error. |
| MissingParameter.SdkAppId | SdkAppId is missing. |
| MissingParameter.TaskId | TaskId parameter missing. |