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