Получение операций

Статья
03/06/2025

Заметка

API портала Cloud Partner интегрированы и будут продолжать работать в Центре партнеров. Переход вводит небольшие изменения. Просмотрите изменения, перечисленные в справочнике по API портала Cloud Partner, чтобы убедиться, что код продолжает работать после перехода в Центр партнеров. API CPP следует использовать только для существующих продуктов, которые уже были интегрированы перед переходом в Центр партнеров; новые продукты должны использовать API отправки Центра партнеров.

Извлекает все операции с предложением или получение определенной операции для указанного идентификатора операции. Клиент может использовать параметры запроса для фильтрации при выполнении операций.

GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31

Параметры URI

имени	описание	типа данных
publisherId	Идентификатор издателя, например `Contoso`	Струна
offerId	Идентификатор предложения	Струна
operationId	GUID, который однозначно идентифицирует операцию в предложении. Идентификатор операции может быть получен с помощью этого API, а также возвращается в заголовке HTTP ответа для любой длительной операции, например api публикации предложения публикации.	Guid
версия API	Последняя версия API	Дата

имени	значение
Тип контента	`application/json`
Авторизация	`Bearer YOUR_TOKEN`

Пример текста

Ответ

Операции 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"
        }
    ]

Операция 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": [],
            }
        }
    ]

Свойства текста ответа

имени	описание
идентификатор	GUID, который однозначно идентифицирует операцию
тип отправки	Определяет тип операции, сообщаемой для предложения, например `Publish/GoLive`
createdDateTime	Дата и время в формате UTC при создании операции
lastActionDateTime	Дата и время в формате UTC, когда последнее обновление было выполнено в операции
статус	Состояние операции либо `not started` \| `running` \| `failed` \| `completed`. Одновременно может быть только одна операция с состоянием `running`.
ошибка	Сообщение об ошибке для неудачных операций

Свойства шага ответа

имени	описание
Оценочный интервал времени	Предполагаемая длительность этой операции
идентификатор	Уникальный идентификатор для процесса шага
описание	Описание шага
stepName	Понятное имя шага
статус	Состояние шага `notStarted` \| `running` \| `failed` \| `completed`
Сообщения	Все уведомления или предупреждения, возникшие на этапе. Массив строк
progressPercentage	Целое число от 0 до 100, указывающее ход выполнения шага

Коды состояния ответа

кода	описание
200	`OK` . Запрос был успешно обработан, а запрошенные операции были возвращены.
400	`Bad/Malformed request` . Текст ответа об ошибке может содержать дополнительные сведения.
403	`Forbidden`. Клиент не имеет доступа к указанному пространству имен.
404	`Not found` — указанная сущность не существует.

Поделиться через