Querying Stream Notification Configurations
Function
This API is used to query stream notification configurations.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/notifications/publish
| 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 |
|---|---|---|---|
| domain | Yes | String | Definition Ingest domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. This parameter is mandatory when token authentication is used. It 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| url | String | Definition Callback URL. Constraints N/A Range N/A Default Value N/A |
| auth_sign_key | String | Definition Authentication key. Constraints N/A Range Length: 32 to 128 characters Default Value N/A |
| call_back_area | String | Definition Region where the server for receiving callback notifications is located. Constraints N/A Range Default Value N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
GET https://{endpoint}/v1/{project_id}/notifications/publish?domain=push.example.com Example Responses
Status code: 200
Stream notification configurations queried.
{
"url" : "https://endpoint.com/v1/test"
} Status code: 400
Query stream notification configurations failed.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Stream notification configurations queried. |
| 400 | Query stream notification configurations 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.