Querying the List of Recording Callbacks
Function
This API is used to query the list of recording callbacks that meet specific conditions.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
live:record:listCallbacks
Read
-
-
-
-
URI
GET /v1/{project_id}/record/callbacks
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| publish_domain | No | String | Definition Ingest domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
| app | No | String | Definition Application name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
| offset | No | Integer | Definition Offset where the query starts. Constraints N/A Value range: 0~4096 Default value: 0 |
| limit | No | Integer | Definition Number of records on each page. Constraints N/A Value range: 1~100 Default value: 10 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | No | String | User token. This parameter is mandatory when token authentication is used. The token 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. |
| Authorization | No | String | Authentication information. This parameter is mandatory for AK/SK authentication. |
| X-Sdk-Date | No | String | Time when the request is sent. This parameter is mandatory for AK/SK authentication. |
| X-Project-Id | No | String | Project ID. This parameter is mandatory for AK/SK authentication. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp indicates the current timestamp, and hostname is the name of the server that processes the current API.) |
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Definition Total number of records. Value range: ≥0 |
| callback_config | Array of RecordCallbackConfig objects | Definition Recording callback configuration list. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Record callback ID, which is returned by the server after the callback is created. Range Length: 1 to 128 characters |
| publish_domain | String | Definition Ingest domain name. Range Length: 1 to 255 characters |
| app | String | Definition Application name. Range Length: 1 to 128 characters Exact application matching takes precedence. If no match is found, the wildcard (*) rule is applied. |
| notify_callback_url | String | Definition Callback URL for receiving recording notifications. Range Length: 1 to 1,024 characters |
| notify_event_subscription | Array of strings | Definition Recording notifications. Default value: RECORD_FILE_COMPLETE |
| sign_type | String | Definition Encryption type. Range Default value: HMACSHA256 |
| create_time | String | Definition Creation time. Range The value is a UTC time in the format of yyyy-mm-ddThh:mm:ssZ. |
| update_time | String | Definition Modification time. Range The value is a UTC time in the format of yyyy-mm-ddThh:mm:ssZ. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp indicates the current timestamp, and hostname is the name of the server that processes the current API.) |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
Queries recording callback configurations.
GET https://{endpoint}/v1/{project_id}/record/callbacks?publish_domain=publish.example.com Example Responses
Status code: 200
Query succeeded.
{
"total" : 1,
"callback_config" : [ {
"id" : "e2fe84def7e476651034ec4b9e92bc30",
"publish_domain" : "publish.example.com",
"app" : "*",
"notify_callback_url" : "http://100.95.129.234:8456/base_record_notify",
"notify_event_subscription" : [ "RECORD_FILE_COMPLETE", "RECORD_NEW_FILE_START" ],
"create_time" : "2020-03-02T08:59:45Z",
"update_time" : "2020-03-09T08:59:45Z"
} ]
} Status code: 400
Query failed.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} SDK Sample Code
The SDK sample code is as follows.
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 | 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.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; public class ListRecordCallbackConfigsSolution { 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); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); ListRecordCallbackConfigsRequest request = new ListRecordCallbackConfigsRequest(); try { ListRecordCallbackConfigsResponse response = client.listRecordCallbackConfigs(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()); } } } |
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 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 = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListRecordCallbackConfigsRequest() response = client.list_record_callback_configs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/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 := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListRecordCallbackConfigsRequest{} response, err := client.ListRecordCallbackConfigs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 | Query succeeded. |
| 400 | Query failed. |
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