你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
获取应用程序备份列表
获取可用于此应用程序中每个分区的备份列表。
返回可用于此 Service Fabric 应用程序中每个分区的备份列表。 服务器枚举备份策略中配置的备份位置上可用的所有备份。 它还允许基于开始和结束日期时间筛选结果,或者仅提取每个分区的最新可用备份。
请求
方法 | 请求 URI |
---|---|
GET | /Applications/{applicationId}/$/GetBackups?api-version=6.4&timeout={timeout}&Latest={Latest}&StartDateTimeFilter={StartDateTimeFilter}&EndDateTimeFilter={EndDateTimeFilter}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults} |
参数
名称 | 类型 | 必须 | 位置 |
---|---|---|---|
applicationId |
string | 是 | 路径 |
api-version |
字符串 | 是 | 查询 |
timeout |
整数 (int64) | 否 | 查询 |
Latest |
boolean | 否 | 查询 |
StartDateTimeFilter |
字符串(日期时间) | 否 | 查询 |
EndDateTimeFilter |
字符串(日期时间) | 否 | 查询 |
ContinuationToken |
字符串 | 否 | 查询 |
MaxResults |
整数 (int64) | 否 | 查询 |
applicationId
类型:字符串
必需:是
应用程序的标识。 这通常是不带“fabric:”URI 方案的应用程序全名。
从版本 6.0 开始,分层名称以“~”字符隔开。
例如,如果应用程序名称为“fabric:/myapp/app1”,则在 6.0 及更高版本中应用程序标识为“myapp~app1”,在以前的版本中为“myapp/app1”。
api-version
类型:字符串
必需:是
默认:
API 的版本。 此参数是必需的,其值必须为“6.4”。
Service Fabric REST API 版本基于引入或更改 API 的运行时版本。 Service Fabric 运行时支持多个版本的 API。 此版本是 API 的最新受支持版本。 如果传递的 API 版本较低,则返回的响应可能与本规范中所述的响应不同。
此外,运行时接受高于最新支持版本的任何版本,该版本一直高于当前版本的运行时。 因此,如果最新 API 版本为 6.0,运行时为 6.1,则运行时将接受该 API 的版本 6.1。 但是,API 的行为将按照记录的 6.0 版本执行。
timeout
类型:整数 (int64)
必需:否
默认:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
执行操作的服务器超时,以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。
Latest
类型:布尔值
必需:否
默认:
指定是否仅获取指定时间范围内可用于分区的最新备份。
StartDateTimeFilter
类型:字符串 (日期时间)
必需:否
以 datetime 格式指定要枚举备份的开始日期时间。 必须以 ISO8601 格式指定日期时间。 这是一个可选参数。 如果未指定,则枚举从头开始的所有备份。
EndDateTimeFilter
类型:字符串 (日期时间)
必需:否
以 datetime 格式指定要枚举备份的结束日期时间。 必须以 ISO8601 格式指定日期时间。 这是一个可选参数。 如果未指定,枚举将一直执行到最近的备份。
ContinuationToken
类型:字符串
必需:否
继续标记参数用于获取下一组结果。 如果单个响应无法容纳来自系统的结果,则 API 响应中包括含有非空值的继续标记。 当此值传递到下一个 API 调用时,API 返回下一组结果。 如果没有更多结果,则该继续标记不包含值。 不应将此参数的值进行 URL 编码。
MaxResults
类型:整数 (int64)
必需:否
默认:
InclusiveMinimum: 0
作为分页查询的一部分返回的最大结果数。 此参数定义返回结果数的上限。 如果根据配置中定义的最大消息大小限制,无法将这些结果容纳到消息中,则返回的结果数可能小于指定的最大结果数。 如果此参数为零或者未指定,则分页查询包含返回消息中最多可容纳的结果数。
响应
HTTP 状态代码 | 说明 | 响应架构 |
---|---|---|
200 (正常) | 成功的操作将返回 200 状态代码和备份信息的分页列表。 |
PagedBackupInfoList |
所有其他状态代码 | 详细的错误响应。 |
FabricError |
示例
在某个时间范围内获取应用程序备份
此示例演示如何获取某个时间范围内的应用程序备份列表。
请求
GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&StartDateTimeFilter=2018-01-01T00:00:00Z&EndDateTimeFilter=2018-01-01T23:59:59Z
200 响应
正文
{
"ContinuationToken": "",
"Items": [
{
"BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"ApplicationName": "fabric:/CalcApp",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
},
"BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
"BackupType": "Full",
"ServiceManifestVersion": "1.0.0",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "261",
"CreationTimeUtc": "2018-01-01T09:00:55Z",
"FailureError": null
},
{
"BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
"BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"ApplicationName": "fabric:/CalcApp",
"ServiceManifestVersion": "1.0.0",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
},
"BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
"BackupType": "Incremental",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "446",
"CreationTimeUtc": "2018-01-01T17:01:02Z",
"FailureError": null
},
{
"BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
"BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
"ApplicationName": "fabric:/CalcApp",
"ServiceName": "fabric:/CalcApp/CalcService",
"ServiceManifestVersion": "1.0.0",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
},
"BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
"BackupType": "Full",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "161",
"CreationTimeUtc": "2018-01-01T09:01:02Z",
"FailureError": null
},
{
"BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
"BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
"ApplicationName": "fabric:/CalcApp",
"ServiceName": "fabric:/CalcApp/CalcService",
"ServiceManifestVersion": "1.0.0",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
},
"BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
"BackupType": "Incremental",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "246",
"CreationTimeUtc": "2018-01-01T17:00:34Z",
"FailureError": null
}
]
}
获取最新备份
此示例演示如何获取应用程序中每个分区的最新备份。
请求
GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&Latest=True
200 响应
正文
{
"ContinuationToken": "",
"Items": [
{
"BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
"BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"ApplicationName": "fabric:/CalcApp",
"ServiceName": "fabric:/CalcApp/CalcService",
"ServiceManifestVersion": "1.0.0",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
},
"BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
"BackupType": "Incremental",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "446",
"CreationTimeUtc": "2018-01-01T17:01:02Z",
"FailureError": null
},
{
"BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
"BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
"ApplicationName": "fabric:/CalcApp",
"ServiceManifestVersion": "1.0.0",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
},
"BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
"BackupType": "Incremental",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "246",
"CreationTimeUtc": "2018-01-01T17:00:34Z",
"FailureError": null
}
]
}
限制最大结果数
此示例演示如何获取应用程序备份的列表。 使用 MaxResult 参数,一页中的结果数限制为最多两个。
请求
GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&MaxResults=2
200 响应
正文
{
"ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
"Items": [
{
"BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"ApplicationName": "fabric:/CalcApp",
"ServiceManifestVersion": "1.0.0",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
},
"BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip",
"BackupType": "Full",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "261",
"CreationTimeUtc": "2018-01-01T09:00:55Z",
"FailureError": null
},
{
"BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd",
"BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba",
"ApplicationName": "fabric:/CalcApp",
"ServiceManifestVersion": "1.0.0",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d"
},
"BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip",
"BackupType": "Incremental",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "446",
"CreationTimeUtc": "2018-01-01T17:01:02Z",
"FailureError": null
}
]
}
使用继续标记的页面
此示例演示如何获取应用程序备份的列表。 使用 MaxResult 参数,一页中的结果数限制为最多两个。 此示例使用 ContinuationToken 参数。 此参数的值是从上一个查询提供的;在本例中,如上所示。 响应包含剩余结果和空的 ContinuationToken。 空 ContinuationToken 指示其他结果不可用。
请求
GET http://localhost:19080/Applications/CalcApp/$/GetBackups?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd&MaxResults=2
200 响应
正文
{
"ContinuationToken": "",
"Items": [
{
"BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
"BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
"ApplicationName": "fabric:/CalcApp",
"ServiceManifestVersion": "1.0.0",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
},
"BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip",
"BackupType": "Full",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "161",
"CreationTimeUtc": "2018-01-01T09:01:02Z",
"FailureError": null
},
{
"BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc",
"BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014",
"ApplicationName": "fabric:/CalcApp",
"ServiceManifestVersion": "1.0.0",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionInformation": {
"LowKey": "-9223372036854775808",
"HighKey": "9223372036854775807",
"ServicePartitionKind": "Int64Range",
"Id": "81645ec7-d260-4c59-9533-8f129bde8e83"
},
"BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip",
"BackupType": "Incremental",
"EpochOfLastBackupRecord": {
"DataLossVersion": "131462452931584510",
"ConfigurationVersion": "8589934592"
},
"LsnOfLastBackupRecord": "246",
"CreationTimeUtc": "2018-01-01T17:00:34Z",
"FailureError": null
}
]
}