检索操作
注意
云合作伙伴门户 API 已与合作伙伴中心集成，并将继续在其中工作。 本次转换引入的变更很少。 请查阅云合作伙伴门户 API 参考中列出的更改，以确保代码在转换到合作伙伴中心后能够继续正常运行。 CPP API 应仅用于在转换到合作伙伴中心之前已经集成的现有产品；新产品应使用合作伙伴中心提交 API。
检索针对产品/服务的所有操作或获取指定 operationId 所对应的特定操作。 客户端可以使用查询参数来筛选正在运行的操作。
GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31
URI 参数
| Name |
描述 |
Data type |
| publisherId |
发布者标识符，例如 Contoso |
字符串 |
| offerId |
产品/服务标识符 |
字符串 |
| operationId |
唯一标识针对产品/服务的操作的 GUID。 operationId 可能使用此 API 进行检索，并且还会在响应的 HTTP 标头中返回任何长时间运行的操作（如 发布产品/服务 API）。 |
Guid |
| api-version |
API 的最新版本 |
日期 |
| Name |
值 |
| Content-Type |
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": [],
}
}
]
响应正文属性
| Name |
描述 |
| id |
唯一标识操作的 GUID |
| submissionType |
标识为产品/服务报告的操作类型，例如 Publish/GoLive |
| createdDateTime |
创建操作时的 UTC 日期/时间 |
| lastActionDateTime |
上次更新操作时的 UTC 日期/时间 |
| status |
操作的状态，not started | running | failed | completed。 一次只能有一个操作具有状态 running。 |
| error |
操作失败的错误消息 |
响应步骤属性
| Name |
描述 |
| estimatedTimeFrame |
预计操作持续时间 |
| id |
步骤过程的唯一标识符 |
| description |
步骤的说明 |
| stepName |
步骤的易记名称 |
| status |
步骤的状态，可以是 notStarted | running | failed | completed |
| messages |
在此步骤中遇到的任何通知或警告。 字符串数组 |
| progressPercentage |
0 到 100 之间的一个整数，用于指示步骤的进度 |
响应状态代码
| 代码 |
描述 |
| 200 |
OK - 请求已成功处理，并返回了请求的操作。 |
| 400 |
Bad/Malformed request - 错误响应正文可能包含更多信息。 |
| 403 |
Forbidden - 客户端无法访问指定的命名空间。 |
| 404 |
Not found - 指定的实体不存在。 |