您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

获取由策略备份的所有实体

获取与此策略关联的备份实体的列表。

返回与此备份策略关联的 Service Fabric 应用程序、服务或分区的列表。

请求

方法 请求 URI
GET /BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

参数

名称 类型 必需 位置
backupPolicyName string 路径
api-version string 查询
ContinuationToken string 查询
MaxResults 整数 (int64) 查询
timeout 整数 (int64) 查询

backupPolicyName

类型: string
是否 必需:是

备份策略的名称。


api-version

类型: string
是否 必需:是
默认6.4

API 的版本。 此参数是必需的,其值必须是 "6.4"。

Service Fabric REST API 版本基于引入或更改 API 的运行时版本。 Service Fabric 运行时支持 API 的多个版本。 此版本是 API 的最新支持版本。 如果传递的 API 版本较低,则返回的响应可能与此规范中所述的响应不同。

此外,运行时还接受高于当前版本的运行时最新支持版本的任何版本。 因此,如果最新的 API 版本为6.0,运行时为6.1,则运行时将接受该 API 的版本6.1。 但是,API 的行为将按记录的6.0 版本进行。


ContinuationToken

类型: string
是否 必需:否

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


MaxResults

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

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


timeout

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

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

响应

HTTP 状态代码 说明 响应架构
200 (正常) 成功的操作将返回200状态代码以及与此策略关联 Service Fabric 实体的页面列表。
PagedBackupEntityList
所有其他状态代码 详细的错误响应。
FabricError

示例

限制最大结果

此示例演示如何获取当前与备份策略关联的备份实体的列表。 使用 MaxResult 参数将页面中的结果数限制为最多两个。

请求

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&MaxResults=2

200响应

正文
{
  "ContinuationToken": "fabric:/DemoApp",
  "Items": [
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/CalcApp"
    },
    {
      "EntityKind": "Application",
      "ApplicationName": "fabric:/DemoApp"
    }
  ]
}

使用继续标记的页面

此示例演示如何获取当前与备份策略关联的备份实体的列表。 此示例使用 ContinuationToken 参数。 此参数的值是从上一个查询提供的;在这种情况下,上面显示的示例。 响应包含剩余结果和空的 ContinuationToken。 空的 ContinuationToken 指示其他结果不可用。

请求

GET http://localhost:19080/BackupRestore/BackupPolicies/DailyAzureBackupPolicy/$/GetBackupEnabledEntities?api-version=6.4&ContinuationToken=fabric:/DemoApp&MaxResults=2

200响应

正文
{
  "ContinuationToken": "",
  "Items": [
    {
      "EntityKind": "Service",
      "ServiceName": "fabric:/VotingApp/VotingActorService"
    }
  ]
}