你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

获取 Compose 部署状态列表

获取在 Service Fabric 群集中创建的 compose 部署列表。

获取 Service Fabric 群集中已创建的或正在创建的 compose 部署的状态。 响应包括名称、状态和有关 compose 部署的其他详细信息。 如果部署列表在一页中显示不下,则将返回一页结果及一个继续标记,该标记可用于获取下一页。

请求

方法 请求 URI
GET /ComposeDeployments?api-version=6.0-preview&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

参数

名称 类型 必须 位置
api-version string 查询
ContinuationToken 字符串 查询
MaxResults 整数 (int64) 查询
timeout 整数 (int64) 查询

api-version

类型:字符串
必需:是
默认

API 的版本。 此参数是必需的,其值必须为“6.0-preview”。


ContinuationToken

类型:字符串
必需:否

继续标记参数用于获取下一组结果。 如果单个响应无法容纳来自系统的结果,则 API 响应中包括含有非空值的继续标记。 当此值传递到下一个 API 调用时,API 返回下一组结果。 如果没有更多结果,则该继续标记不包含值。 不应将此参数的值进行 URL 编码。


MaxResults

类型:整数 (int64)
必需:否
默认
InclusiveMinimum0

作为分页查询的一部分返回的最大结果数。 此参数定义返回结果数的上限。 如果根据配置中定义的最大消息大小限制,无法将这些结果容纳到消息中,则返回的结果数可能小于指定的最大结果数。 如果此参数为零或者未指定,则分页查询包含返回消息中最多可容纳的结果数。


timeout

类型:整数 (int64)
必需:否
默认
InclusiveMaximum4294967295
InclusiveMinimum1

执行操作的服务器超时,以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。

响应

HTTP 状态代码 说明 响应架构
200 (正常) 群集中组合部署的状态列表。
PagedComposeDeploymentStatusInfoList
所有其他状态代码 详细的错误响应。
FabricError