...
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/ |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
|
|
...
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
Создать ресурс
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/
- Тип запроса: POST
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с данными создаваемого ресурса
- Тип данных ответа: JSON Object
...
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| панель |
---|
|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
| панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Информация |
---|
|
Для получения неактивных ресурсов используйте query-параметр "active" с значением "false" |
Получить конкретный ресурс
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: GET
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
Доступные параметры query string (* - обязательный параметр):
...
Возможные коды ответа:
...
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
Обратите внимание
Для получения неактивного ресурса используйте query-параметр "active" с значением "false"
Получить статус конкретного ресурса
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/status/live/<resource_id>
- Тип запроса: GET
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
...
Формат данных ответа:
...
[
{
"name": "test_resource",
"settings": {
"RTMP-publish": {
"domain": "p0q2zwj4yih.a.trbcdn.net",
"pub_protocol": "rtmp",
"master_stream": "jws2w_test_resource.smil",
"primary": "a.r.rcloud.ru",
"application": "livemaster",
"dist_protocol": "https",
"backup": "b.r.rcloud.ru"
}
},
"streams": {
"someid1": {
"stream_name": "someid1_stream01",
"password": "RtdHESB7aA7rdKDCuVYn5W9Zp",
"resolution": "720p",
"name": "stream01",
"smil": {
"BANDWIDTH": "5000000",
"RESOLUTION": "1280x720"
}
},
"someid2": {
"stream_name": "someid2_stream02",
"password": "dRKLVu6v90P5PhSAMIGSIgKuh",
"resolution": "1080p",
"name": "stream02",
"smil": {
"BANDWIDTH": "10000000",
"RESOLUTION": "1920x1080"
}
}
},
"active": true,
"creation_ts": 1542872090,
"type": "RTMP-publish",
"id": "1163546047721937079_p0q2zwj4yih",
"resources": {
"http": "test"
},
"cdn_domain": "test.a.trbcdn.net",
"description": ""
}
] |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
| панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Изменить ресурс
Обратите внимание
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.
{"status": "error", "message": "Not allowed method", "description": "Request is forbidden"} |
|
|
Информация |
---|
|
Для получения неактивных ресурсов используйте query-параметр "active" с значением "false" |
Получить конкретный ресурс
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUTGET
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с новыми данными ресурса
- Тип данных ответа: JSON Object
...
Доступные параметры query string (* - обязательный параметр):
Название | Описание | Допустимые значения | Значение по умолчанию |
---|
active | Фильтр по активным/деактивированным ресурсам | true / false | true |
Возможные коды ответа:
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | Конкретный LIVE-ресурс для аккаунта или описание ошибки | None | Изменен, id задачи в общей очереди задач JSON | Получен ресурс или ошибка |
400403 | None | None | Неверный запросЗапрещено |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
Активировать ресурс
Обратите внимание
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
...
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
...
language | xml |
---|
theme | Confluence |
---|
Локальная авторизация $
Создание ресурса с локальной авторизацией
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/
- Тип запроса: POST
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с данными создаваемого ресурса и параметрами локальной авторизации
- Тип данных ответа: JSON Object
...
панель |
---|
|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/1163546047721937079_p0q2zwj4yih |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
| панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Деактивировать ресурс
Обратите внимание
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
...
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
{
"name": "test_resource",
"settings": {
"RTMP-publish": {
"domain": "p0q2zwj4yih.a.trbcdn.net",
"pub_protocol": "rtmp",
"master_stream": "jws2w_test_resource.smil",
"primary": "a.r.rcloud.ru",
"application": "livemaster",
"dist_protocol": "https",
"backup": "b.r.rcloud.ru"
}
},
"streams": {
"someid1": {
"stream_name": "someid1_stream01",
"password": "RtdHESB7aA7rdKDCuVYn5W9Zp",
"resolution": "720p",
"name": "stream01",
"smil": {
"BANDWIDTH": "5000000",
"RESOLUTION": "1280x720"
}
},
"someid2": {
"stream_name": "someid2_stream02",
"password": "dRKLVu6v90P5PhSAMIGSIgKuh",
"resolution": "1080p",
"name": "stream02",
"smil": {
"BANDWIDTH": "10000000",
"RESOLUTION": "1920x1080"
}
}
},
"active": true,
"creation_ts": 1542872090,
"type": "RTMP-publish",
"id": "1163546047721937079_p0q2zwj4yih",
"resources": {
"http": "test"
},
"cdn_domain": "test.a.trbcdn.net",
"description": ""
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
| панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Изменение локальной авторизации ресурса
Обратите внимание
...
{"status": "error", "message": "Not allowed method", "description": "Request is forbidden"} |
|
|
Информация |
---|
|
Для получения неактивного ресурса используйте query-параметр "active" с значением "false" |
Получить статус конкретного ресурса
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resourcestatus/live/<resource_id>
- Тип запроса: PUTGET
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с измененными параметрами локальной авторизации
- Тип данных ответа: JSON Object
...
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id Статус Live-ресурса или описание ошибки | None | Изменен, id задачи в общей очереди задач JSON | Получен статус ресурса или ошибка |
400403 | None | None | Неверный запросЗапрещено |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
...
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
...
language | xml |
---|
theme | Confluence |
---|
...
Формат данных ответа:
Параметр | Описание | Возможные значения |
---|
resource | ID ресурса | ID ресурса из URL запроса |
status | Статус ресурса | "Completed" / "Processing" / "Error" |
message | Описание статуса | "" / "dns processing" / "configuration processing" |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Внешняя авторизация $
Создание ресурса с внешней авторизацией
...
curl -H "CDN-AUTH-TOKEN: $TOKEN" https://apicdn.rcloud.ru/cdn/api/v1/ |
|
...
...
- Тип запроса: POST
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с данными создаваемого ресурса и параметрами внешней авторизации
- Тип данных ответа: JSON Object
...
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| панель |
---|
|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного 3087695896608003328_cybku4cl0av |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"resource": "3087695896608003328_cybku4cl0av", "status": "Completed", "message": ""} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
| панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Изменение внешней авторизации ресурса
Обратите внимание
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.
{"status": "error", "message": "Invalid Token", "description": "Invalid or expired token"} |
|
|
Создать ресурс
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUTPOST
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с измененными параметрами внешней авторизацииданными создаваемого ресурса
- Тип данных ответа: JSON Object
...
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id, resource_id или описание ошибки | NoneJSON | ИзмененСоздан, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X POST \
-d '{"name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "720p"}, "someid2": {"name": "stream02", "resolution": "1080p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/ |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103450831469",
"resource_id": "1163546047721937079_p0q2zwj4yih"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Json invalid", "description": "required key name isn't provided"} |
|
|
Изменить ресурс
Информация |
---|
|
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса. |
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с новыми данными ресурса
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id или описание ошибки | None | Изменен, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PUT \
-d '{"name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "360p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/1163546047721937079_p0q2zwj4yih |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103856008585"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Json invalid", "description": "stream key length should be between 5 and 10. Not 17"} |
|
|
Деактивировать ресурс
Информация |
---|
|
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса. |
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id или описание ошибки | JSON | Деактивирован, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PUT \
-d '{"name": "test_resource", "active": false, "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "360p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/1163546047721937079_p0q2zwj4yih |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103856008586"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Not allowed method", "description": "Request is forbidden"} |
|
|
Активировать ресурс
Информация |
---|
|
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса. |
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id или описание ошибки | JSON | Активирован, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PUT \
-d '{"name": "test_resource", "active": true, "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "360p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/1163546047721937079_p0q2zwj4yih |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103856008586"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Not allowed method", "description": "Request is forbidden"} |
|
|
Локальная авторизация $
Создание ресурса с локальной авторизацией
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/
- Тип запроса: POST
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с данными создаваемого ресурса и параметрами локальной авторизации
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id, resource_id или описание ошибки | JSON | Создан, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X POST \
-d '{"auth": {"md5": {"secret": "123", "forever": true, "anywhere": true}}, "name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "720p"}, "someid2": {"name": "stream02", "resolution": "1080p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/ |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103450831469",
"resource_id": "1163546047721937079_p0q2zwj4yih"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Json invalid", "description": "required key name isn't provided"} |
|
|
Изменение локальной авторизации ресурса
Информация |
---|
|
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса. |
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с измененными параметрами локальной авторизации
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id или описание ошибки | None | Изменен, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PUT \
-d '{"auth": {"md5": {"secret": "456", "forever": true}}, "name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "360p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/1163546047721937079_p0q2zwj4yih |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103856008585"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Json invalid", "description": "stream key length should be between 5 and 10. Not 17"} |
|
|
Внешняя авторизация $
Создание ресурса с внешней авторизацией
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/
- Тип запроса: POST
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с данными создаваемого ресурса и параметрами внешней авторизации
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id, resource_id или описание ошибки | JSON | Создан, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X POST \
-d '{"auth": {"url": "https://test.com/yourscript"}, "name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "720p"}, "someid2": {"name": "stream02", "resolution": "1080p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/ |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103450831469",
"resource_id": "1163546047721937079_p0q2zwj4yih"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Json invalid", "description": "required key name isn't provided"} |
|
|
Изменение внешней авторизации ресурса
Информация |
---|
|
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса. |
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с измененными параметрами внешней авторизации
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id или описание ошибки | None | Изменен, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PUT \
-d '{"auth": {"url": "https://test.com/yourscript2"}, "name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "360p"}}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/1163546047721937079_p0q2zwj4yih |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20181122103856008585"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Json invalid", "description": "stream key length should be between 5 and 10. Not 17"} |
|
|
Ограничения раздачи $
Создание ресурса с ограничением раздачи по странам, IP адресам, referer или User-Agent
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/
- Тип запроса: POST
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с данными создаваемого ресурса и параметрами ограничений
- Тип данных ответа: JSON Object
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id, resource_id или описание ошибки | JSON | Создан, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X POST \
-d '{"name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "720p"}}, "limitations": {"geo": [{"default_action": "allow", "exclude": [{"country": "RU", "region": "BEL", "action": "deny"}], "times": [{"start": "2019-07-20T14:17:00Z", "end": "2019-07-20T14:18:00Z"}]}, {"default_action": "allow", "exclude": [{"country": "RU", "region": "CR", "action": "deny"}, {"country": "RU", "region": null, "action": "deny"}], "times": [{"start": "2019-07-20T14:19:00Z", "end": null}]}], "ip": [{"default_action": "deny", "exclude": [{"ip":"192.168.0.1/24"}], "times": [{"start": "2019-07-20T14:17:00Z", "end": "2019-07-20T14:18:00Z"}]}], "referer": [{"default_action": "deny", "exclude": [{"referer":"*.ru"}], "times": [{"start": null, "end": "2019-07-20T14:18:00Z"}]}], "useragent": [{"default_action": "deny", "exclude": [{"useragent": "browser_name"}], "times": [{"start": "2019-07-20T14:17:00Z", "end": "2019-07-20T14:18:00Z"}]}]}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/ |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "accept",
"task_id": "20180402162358692413",
"resource_id": "1163546047721937079_p0q2zwj4yih"
} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Ограничения раздачи $
...
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {
"status": "error",
"message": "json invalid",
"description": "limitations : Invalid time interval: start:2021-05-11T19:12:00Z, end:2021-05-09T22:12:00Z"
} |
|
|
Изменение ограничений раздачи ресурса
Информация |
---|
|
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса. |
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: POSTPUT
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с данными создаваемого ресурса и измененными параметрами ограничений
- Тип данных ответа: JSON Object
...
Код ответа | Данные ответа | Формат ответа | Описание |
---|
200 | task_id , resource_id или описание ошибки | JSONNone | СозданИзменен, id задачи в общей очереди задач или ошибка |
400 | None | None | Неверный запрос |
404 | None | None | Не найдено |
500 | None | None | Внутренняя ошибка сервера |
503 | None | None | Сервис недоступен |
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
панель |
---|
borderColor | #00c853 | #e5f9ed | title | Пример успешного ответа |
---|
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример |
---|
| неуспешного ответа | Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
|
Изменение ограничений раздачи ресурса
Обратите внимание
Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.
URL: https://apicdn.rcloud.ru/cdn/api/v1/<your_account_name>/resource/live/<resource_id>
- Тип запроса: PUT
- Заголовки: CDN-AUTH-TOKEN
- Тело запроса: JSON с измененными параметрами ограничений
- Тип данных ответа: JSON Object
...
панель |
---|
borderColor | #448aff |
---|
titleBGColor | #ecf3ff |
---|
borderStyle | solid |
---|
title | Пример запроса |
---|
|
Блок кода |
---|
|
language | xml |
---|
theme | Confluencecurl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PUT \
-d '{"name": "test_resource", "type": "RTMP-publish", "streams": {"someid1": {"name": "stream01", "resolution": "720p"}}, "limitations": { "ip": [{"default_action": "deny", "exclude": [{"ip":"192.168.0.1/24"}], "times": []}]}}' \
https://apicdn.rcloud.ru/cdn/api/v1/testaccount/resource/live/1163546047721937079_p0q2zwj4yih |
панель |
---|
borderColor | #00c853 |
---|
titleBGColor | #e5f9ed |
---|
title | Пример успешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "accept", "task_id": "20180402162358692413"} |
|
панель |
---|
borderColor | #ff5252 |
---|
titleBGColor | #ffeded |
---|
title | Пример неуспешного ответа |
---|
| Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
| {"status": "error", "message": "Not allowed method", "description": "Request is forbidden"} |
|
|
Получение ссылок для публикации и раздачи
...
Ссылка для публикации потока
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
<pub_protocol>://<primary| |
...
backup>/<application>/<stream_name>?auth=<password> |
...
Пример итоговой ссылки для публикации:
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
rtmp://a.r.rcloud.ru/livemaster/someid1_stream01?auth=MkE5MGtjbPljT52t491y6z14C |
...
Ссылка для раздачи потока
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
<dist_protocol>://<domain>/<application>/<master_stream>/playlist.m3u8 |
...
Пример итоговой ссылки для раздачи:
Блок кода |
---|
language | xml |
---|
theme | Confluence |
---|
|
https://p0q2zwj4yih.a.trbcdn.net/livemaster/jws2w_test_resource.smil/playlist.m3u8 |
...
Транскодирование $
Вы можете заказать услугу транскодирования входного потока в несколько качеств. Это позволит избежать дополнительных затрат на оборудование или программное обеспечение.
...