你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
获取服务备份配置信息
获取 Service Fabric 服务备份配置信息。
获取该服务的 Service Fabric 备份配置信息以及此服务下的分区。
请求
方法 | 请求 URI |
---|---|
GET | /Services/{serviceId}/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
参数
名称 | 类型 | 必须 | 位置 |
---|---|---|---|
serviceId |
string | 是 | 路径 |
api-version |
字符串 | 是 | 查询 |
ContinuationToken |
字符串 | 否 | 查询 |
MaxResults |
整数 (int64) | 否 | 查询 |
timeout |
整数 (int64) | 否 | 查询 |
serviceId
类型:字符串
必需:是
服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务全名。
从版本 6.0 开始,分层名称以“~”字符隔开。
例如,如果服务名称为“fabric:/myapp/app1/svc1”,则 6.0 及更高版本中的服务标识为“myapp~app1~svc1”,在以前的版本中为“myapp/app1/svc1”。
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 版本执行。
ContinuationToken
类型:字符串
必需:否
继续标记参数用于获取下一组结果。 如果单个响应无法容纳来自系统的结果,则 API 响应中包括含有非空值的继续标记。 当此值传递到下一个 API 调用时,API 返回下一组结果。 如果没有更多结果,则该继续标记不包含值。 不应将此参数的值进行 URL 编码。
MaxResults
类型:整数 (int64)
必需:否
默认:
InclusiveMinimum: 0
作为分页查询的一部分返回的最大结果数。 此参数定义返回结果数的上限。 如果根据配置中定义的最大消息大小限制,无法将这些结果容纳到消息中,则返回的结果数可能小于指定的最大结果数。 如果此参数为零或者未指定,则分页查询包含返回消息中最多可容纳的结果数。
timeout
类型:整数 (int64)
必需:否
默认:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
执行操作的服务器超时,以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。
响应
HTTP 状态代码 | 说明 | 响应架构 |
---|---|---|
200 (正常) | 成功的操作将返回 200 状态代码和该服务的备份配置信息分页列表,以及此服务下的分区(其备份配置已被重写)。 |
PagedBackupConfigurationInfoList |
所有其他状态代码 | 详细的错误响应。 |
FabricError |
示例
限制最大结果数
此示例演示如何获取此服务和此服务下的分区的备份配置列表。 使用 MaxResult 参数,一页中的结果数限制为最多两个。
请求
GET http://localhost:19080/Services/CalcApp/CalcService/$/GetBackupConfigurationInfo?api-version=6.4&MaxResults=2
200 响应
正文
{
"ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"Items": [
{
"Kind": "Service",
"PolicyName": "BackupPolicy1",
"PolicyInheritedFrom": "Application",
"ServiceName": "fabric:/CalcApp/CalcService",
"SuspensionInfo": {
"IsSuspended": false,
"SuspensionInheritedFrom": "Invalid"
}
},
{
"Kind": "Partition",
"PolicyName": "BackupPolicy2",
"PolicyInheritedFrom": "Partition",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"SuspensionInfo": {
"IsSuspended": false,
"SuspensionInheritedFrom": "Invalid"
}
}
]
}
使用继续标记的页面
此示例演示如何获取此服务和此服务下的分区的备份配置列表。 使用 MaxResult 参数,一页中的结果数限制为最多两个。 此示例使用 ContinuationToken 参数。 此参数的值是从上一个查询提供的;在本例中,如上所示。 响应包含剩余结果和空的 ContinuationToken。 空 ContinuationToken 指示其他结果不可用。
请求
GET http://localhost:19080/Services/CalcApp/CalcService/$/GetBackupConfigurationInfo?api-version=6.4&ContinuationToken=fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d&MaxResults=2
200 响应
正文
{
"ContinuationToken": "",
"Items": [
{
"Kind": "Partition",
"PolicyName": "BackupPolicy1",
"PolicyInheritedFrom": "Application",
"ServiceName": "fabric:/CalcApp/CalcService",
"PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6",
"SuspensionInfo": {
"IsSuspended": true,
"SuspensionInheritedFrom": "Partition"
}
}
]
}