Encaminha a lista de URLs fornecida para o provedor CDN (Content Distribution Network) da Dynamic Media para invalidar seu cache existente de respostas HTTP.
A invalidação do cache CDN força todas as solicitações HTTP para esses URLs serem revalidadas em relação aos dados publicados atuais na rede Dynamic Media depois que essa solicitação de invalidação é processada pela rede CDN. Todos os URLs que não estão conectados à estrutura de URL do serviço Dynamic Media e correspondem diretamente à ID raiz da empresa Dynamic Media atribuída quando a empresa é criada resultarão em uma falha de API para toda a solicitação. Todos os URLs inválidos que a CDN não suporta e que considera inválidos também resultarão em uma falha da API para toda a solicitação.
Frequência de utilização: Regras
As regras que regem a frequência do uso desse recurso são controladas pelos parceiros CDN do Dynamic Media. A CDN mantém a discrição para degradar a capacidade de resposta dessas invalidações para manter o desempenho ideal do seu serviço para seus usuários. Caso a Dynamic Media seja notificada sobre o uso excessivo desse recurso, precisaremos usar a desativação do recurso por empresa ou totalmente pelo serviço.
Emails de confirmação
Os emails de confirmação do parceiro CDN do Dynamic Media podem ser enviados para o criador da lista ou até 5 outros endereços de email. A API envia a confirmação quando toda a rede CDN foi notificada de que os URLs referenciados no email foram apagados. Uma única chamada para cdnCacheInvalidation
pode enviar vários emails se o número de URLs fornecidas exceder o número que a Dynamic Media pode fornecer ao parceiro CDN em uma única notificação. Atualmente, isso seria se a solicitação excedesse 100 URLs, mas está sujeita a alterações com base na solicitação do parceiro da CDN.
Suportado desde
6,0
IpsAdmin
IpsCompanyAdmin
Entrada ( cdnCacheInvalidationParam
)
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
companyHandle |
xsd:string |
Sim |
O identificador da empresa conectada aos URLs para invalidar. |
urlArray |
tipos:UrlArray |
Sim |
Lista de até 1000 URLs para invalidar do cache CDN. Todos os URLS devem conter a ID raiz da empresa do Dynamic Media para serem invalidados. |
Saída( cdnCacheInvalidationReturn
)
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
invalidationHandle |
xsd:string |
Sim |
Um identificador que faz referência à solicitação de limpeza. A API cdnCacheInvalidation agora invalida o cache quase imediatamente (~5 segundos). Dessa forma, a pesquisa por status de invalidação geralmente não é mais necessária. |
estimatedSeconds |
xsd:int |
Sim |
Segundos estimados para a conclusão da solicitação de limpeza. Os clientes devem aguardar por esse tempo antes de pesquisar o status. |
Este exemplo solicita que quatro URLs sejam invalidadas no cache CDN. A resposta contém contagens resumidas do sucesso das operações e uma lista de detalhes de erro fornecidos diretamente da CDN para ajudar o cliente a usar esse recurso.
getCdnCacheInvalidationStatus
operação.
Solicitação
<cdnCacheInvalidationParam xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
<companyHandle>c|6</companyHandle>
<urlArray>
<items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$thumbnail$</items>
<items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$product$</items>
<items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$large$</items>
<items>http://s7d7.scene7.com/is/image/JJEsquire/ImageSetConfigDefaults?req=userdata</items>
</urlArray>
</cdnCacheInvalidationParam>
Resposta
<cdnCacheInvalidationReturn xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
<successCount>4</successCount>
<warningCount>0</warningCount>
<errorCount>0</errorCount>
</cdnCacheInvalidationReturn>