CreateRTCWhipStreamAddress - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Descrição da operação

Notas de uso

Chame a operação CreateRTCWhipStreamAddress para criar uma URL de ingestão WHIP (WhipAddress) para o canal RTC especificado.
Use o OBS para ingerir um fluxo usando o protocolo WHIP.
- Execute a ferramenta de streaming do OBS.
- Na barra de menus, escolha File > Settings.
- Na página Settings, selecione Stream, configure as seguintes informações e clique em OK.
  
  Parâmetro Descrição
  Service Defina Service como WHIP.
  Server Use o WhipAddress gerado pela operação na Etapa 1.
  Bearer Token Deixe a chave de fluxo vazia.
Outros usuários podem entrar no canal correspondente para assistir ao fluxo.

Limite de QPS

O limite de QPS por usuário único para esta operação é de 40 chamadas por segundo. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Chame esta operação adequadamente.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

live:CreateRTCWhipStreamAddress

none

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O parâmetro de idempotência. Nota Este parâmetro é usado para identificar se várias solicitações são a mesma solicitação. Recomendamos que você não especifique este parâmetro para esta operação.	58E73333-xxxx-xxxx-xxxx
AppId	string	Sim	O ID do aplicativo. Você pode visualizar seus IDs de aplicativo navegando até ApsaraVideo Live > Live+ > ApsaraVideo Real-time Communication > Application Management. Se nenhum aplicativo existir, crie um clicando em Create Application.	6a06dcc-xxxx-xxxx-xxxx-ee3exxxxxx
ChannelId	string	Sim	O ID do canal ao qual entrar.	ch00000****001
UserId	string	Sim	O ID do usuário. O ID do usuário deve ser exclusivo dentro do canal.	zb0000****0001
DisplayName	string	Sim	O nome de exibição do usuário no canal. Nota Caracteres chineses e outros caracteres são suportados. Para evitar nomes excessivamente longos, mantenha o tamanho abaixo de 32 bytes.	主播小二
ExpireTime	integer	Não	O período de validade da URL de ingestão. Unidade: segundos. Valor padrão: 43200. Nota Se o período de validade expirar, um fluxo em andamento que usa a URL gerada por esta operação não será afetado. No entanto, uma nova tentativa de ingestão de fluxo usando a mesma URL falhará.	43200

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	58E7D4-xxxx-xxxx-xxxx-6B56Cxxxxx
WhipAddress	string	A URL do protocolo WHIP.	https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b*5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2NjNDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "58E7**D4-xxxx-xxxx-xxxx-6B5**6Cxxxxx",
  "WhipAddress": "https://xxxxxx.media-sh.xxxxx.com/xxxxxxxxxxxx/3723a3xxxxxxxxx223c606b***5f7a2bc7c56ea5cdd0xxxxe?auth_key=17495xxxxx-xxxx-0-f013003067c78c4053f9cd0xxxxxxx&qqzr=H4sIAAAAAAAC_6pWSlayUkrOMxxxxxxrPyCxQ0lFKQTCLlKyUjM2Nj**NDQ1TEy2Mjc3xxxxxxxxxxqRYAAAD__xxxxx__xxxxxxxx"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InputInvalid	%s.	Os parâmetros de entrada são inválidos.
500	ServerError	%s.	Ocorreu um erro desconhecido. Tente novamente mais tarde ou abra um ticket.
403	NoAuth	%s.	Você não tem as permissões necessárias.
404	ResourceNotExist	%s.	O recurso solicitado não existe. Verifique a solicitação e tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.

Parâmetro	Descrição
Service	Defina Service como WHIP.
Server	Use o WhipAddress gerado pela operação na Etapa 1.
Bearer Token	Deixe a chave de fluxo vazia.