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

获取属性信息列表 v82

获取给定名称下的所有 Service Fabric 属性的信息。

一个 Service Fabric 名称可具有一个或多个存储自定义信息的命名属性。 此操作将有关这些属性的信息获取到分页列表中。 信息包括有关其中每个属性的名称、值和元数据。

请求

方法 请求 URI
GET /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout}

参数

名称 类型 必需 位置
nameId string 路径
api-version 字符串 查询
IncludeValues boolean 查询
ContinuationToken 字符串 查询
timeout integer (int64) 查询

nameId

类型:字符串
必需:是

Service Fabric 名称,不带“fabric:”URI 方案。


api-version

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

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

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

此外,运行时接受的任何版本都高于当前版本的运行时支持的版本。 因此,如果最新的 API 版本为 6.0,但如果运行时为 6.1,以便更轻松地编写客户端,运行时将接受该 API 的版本 6.1。 但是,API 的行为将按照所记录的 6.0 版本进行。


IncludeValues

类型:布尔值
必需:否
默认

允许指定是否包括返回的属性的值。 如果值应随元数据一起返回,则为 true;如果为 false,则仅返回属性元数据。


ContinuationToken

类型:字符串
必需:否

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


timeout

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

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

响应

HTTP 状态代码 说明 响应架构
200 (正常) Service Fabric属性的分页列表。
PagedPropertyInfoList
所有其他状态代码 详细的错误响应。
FabricError

示例

获取属性信息列表

此示例演示如何获取给定名称下的所有Service Fabric属性。

请求

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0

200 响应

Body
{
  "ContinuationToken": "PersistentQueueAppData$131439231986491349",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "CalculatorAppData",
      "Metadata": {
        "TypeId": "Int64",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
        "SequenceNumber": "10"
      }
    },
    {
      "Name": "PersistentQueueAppData",
      "Metadata": {
        "TypeId": "Binary",
        "CustomTypeId": "InitializationDataType",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
        "SequenceNumber": "12"
      }
    }
  ]
}

获取包含值的属性信息列表

此示例演示如何获取给定名称下的所有Service Fabric属性及其值。

请求

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True

200 响应

Body
{
  "ContinuationToken": "PersistentQueueAppData$131439231986491349",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "CalculatorAppData",
      "Value": {
        "Kind": "Int64",
        "Data": "4534"
      },
      "Metadata": {
        "TypeId": "Int64",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "8",
        "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z",
        "SequenceNumber": "10"
      }
    },
    {
      "Name": "PersistentQueueAppData",
      "Value": {
        "Kind": "Binary",
        "Data": [
          "6",
          "7",
          "8",
          "9",
          "10"
        ]
      },
      "Metadata": {
        "TypeId": "Binary",
        "CustomTypeId": "InitializationDataType",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "5",
        "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z",
        "SequenceNumber": "12"
      }
    }
  ]
}

使用延续标记的页面

此示例演示如何使用 ContinuationToken 参数在给定Service Fabric名称下浏览有关属性的信息。 此参数的值是从上一个查询提供的,在本例中,如上所示。 响应包含其余两个结果和一个空的 ContinuationToken。 空的 ContinuationToken 指示其他结果不可用。

请求

GET http://localhost:19080/Names/samples/apps/$/GetProperties?api-version=6.0&IncludeValues=True&ContinuationToken=PersistentQueueAppData$131439231986491349

200 响应

Body
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "Properties": [
    {
      "Name": "VolatileQueueAppData",
      "Value": {
        "Kind": "Double",
        "Data": "67.89"
      },
      "Metadata": {
        "TypeId": "Double",
        "CustomTypeId": "",
        "Parent": "fabric:/samples/apps",
        "SizeInBytes": "8",
        "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z",
        "SequenceNumber": "8"
      }
    }
  ]
}