Recuperar operações
Artigo 06/14/2024
2 colaboradores
Comentários
Neste artigo
Observação
As APIs do Portal do Cloud Partner são integradas ao Partner Center e continuarão funcionando nele. A transição introduz pequenas alterações. Examine as alterações listadas na API do Portal do Cloud Partner para garantir que seu código continue funcionando após a transição para o Cloud Partner. As APIs do CPP somente devem ser usadas em produtos existentes que já foram integrados antes da transição para o Partner Center. Os novos produtos devem usar as APIs de envio do Partner Center.
Recuperar todas as operações na oferta ou obter uma operação específica para a operationId especificada. O cliente pode usar parâmetros de consulta para filtrar operações em execução.
GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31
Parâmetros do URI
Nome Descrição Data type
publisherId
Identificador do editor, por exemplo Contoso
String
offerId
Identificador da oferta
String
operationId
GUID que identifica exclusivamente a operação na oferta. O operationId pode ser recuperado usando essa API e também é retornado no cabeçalho HTTP da resposta para qualquer operação de longa execução, como a API de oferta de publicação.
Guid
api-version
Última versão da API
Data
Nome Valor
Content-Type
application/json
Autorização
Bearer YOUR_TOKEN
Exemplo de corpo
Resposta
Operações GET
[
{
"id": "5a63deb5-925b-4ee0-938b-7c86fbf287c5",
"offerId": "56615b67-2185-49fe-80d2-c4ddf77bb2e8",
"offerVersion": 1,
"offerTypeId": "microsoft-azure-virtualmachines",
"publisherId": "contoso",
"submissionType": "publish",
"submissionState": "running",
"publishingVersion": 2,
"slot": "staging",
"version": 636576975611768314,
"definition": {
"metadata": {
"emails": "jdoe@contoso.com"
}
},
"changedTime": "2018-03-26T21:46:01.179948Z"
}
]
Operação GET
[
{
"status" : "running",
"messages" : [],
"publishingVersion" : 2,
"offerVersion" : 1,
"cancellationRequestState": "canCancel",
"steps": [
{
"estimatedTimeFrame": "< 15 min",
"id": "displaydummycertify",
"stepName": "Validate Pre-Requisites",
"description": "Offer settings provided are validated",
"status": "complete",
"messages":
[
{
"messageHtml": "Step completed.",
"level": "information",
"timestamp": "2017-03-28T19:50:36.500052Z"
}
],
"progressPercentage": 100
},
{
"estimatedTimeFrame": "< 5 day",
"id": "displaycertify",
"stepName": "Certification",
"description": "Your offer is analyzed by our certification systems for issues.",
"status": "blocked",
"messages":
[
{
"messageHtml": "No virtual machine image was found for the plan contoso.",
"level": "error",
"timestamp": "2017-03-28T19:50:39.5506018Z"
},
{
"messageHtml": "This step has not started yet.",
"level": "information",
"timestamp": "2017-03-28T19:50:39.5506018Z"
}
],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "< 1 day",
"id": "displayprovision",
"stepName": "Provisioning",
"description": "Your virtual machine is being replicated in our production systems.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "< 1 hour",
"id": "displaypackage",
"stepName": "Packaging and Lead Generation Registration",
"description": "Your virtual machine is packaged for being shown to your customers. Additionally, we hookup our lead generation systems to send leads for your offer.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"id": "publisher-signoff",
"stepName": "Publisher signoff",
"description": "Offer is available to preview. Ensure that everything looks good before making your offer live.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "~2-5 days",
"id": "live",
"stepName": "Live",
"description": "Offer is publicly visible and is available for purchase.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
}
],
"previewLinks": [],
"liveLinks": [],
}
}
]
Propriedades do corpo de resposta
Nome Descrição
ID
GUID que identifica exclusivamente a operação
submissionType
Identifica o tipo de operação que está sendo relatada para a oferta, por exemplo, Publish/GoLive
createdDateTime
Data e hora em UTC quando a operação foi criada
lastActionDateTime
Data e hora em UTC quando a última atualização foi feita na operação
status
Status da operação, qualquer um dos not started | running | failed | completed. Apenas uma operação pode ter um status running por vez.
error
Mensagem de erro para operações com falha
Propriedades da etapa de resposta
Nome Descrição
estimatedTimeFrame
A duração estimada dessa operação
ID
O identificador exclusivo para o processo da etapa
descrição
Descrição da etapa
stepName
O nome amigável da etapa
status
Status da etapa, qualquer um dos notStarted | running | failed | completed
da nuvem para o dispositivo
Todas as notificações ou avisos encontrados durante a etapa. Matriz das cadeias de caracteres
progressPercentage
Um inteiro de 0 a 100 indicando a progressão da etapa
Códigos de status de resposta
Código Descrição
200
OK - A solicitação foi processada com êxito e as operações solicitadas foram retornadas.
400
Bad/Malformed request - O corpo da resposta ao erro pode conter mais informações.
403
Forbidden - O cliente não tem acesso ao namespace especificado.
404
Not found – a entidade especificada não existe.