Compartir a través de

Obtener lista de información de propiedades

  • Artículo

Obtiene información sobre todas las propiedades de Service Fabric con un nombre concreto.

Un nombre de Service Fabric puede tener una o varias propiedades con nombre que almacenan información personalizada. Esta operación obtiene la información acerca de estas propiedades en una lista paginada. La información incluye nombre, valor y metadatos sobre cada una de las propiedades.

Solicitud

Método URI de solicitud
GET /Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parámetros

Nombre Tipo Requerido Location
nameId string Sí Ruta de acceso
api-version string Sí Consultar
IncludeValues boolean No Consultar
ContinuationToken string No Consultar
timeout entero (int64) No Consultar

nameId

Tipo: cadena
Obligatoria: sí

Nombre de Service Fabric, sin el esquema de URI "fabric".

api-version

Tipo: cadena
Obligatoria: sí
Predeterminado:

La versión de la API. Este parámetro es necesario y su valor debe ser "6.0".

La versión de la API REST de Service Fabric se basa en la versión en tiempo de ejecución en la que se introdujo o se cambió la API. El entorno de ejecución de Service Fabric admite más de una versión de la API. Esta es la versión compatible más reciente de la API. Si se pasa una versión de API anterior, la respuesta devuelta puede ser diferente de la documentada en esta especificación.

Además, el tiempo de ejecución acepta cualquier versión superior a la versión compatible más reciente hasta la versión actual del entorno de ejecución. Por lo tanto, si la versión más reciente de la API es 6.0, pero si el tiempo de ejecución es 6.1, para facilitar la escritura de los clientes, el entorno de ejecución aceptará la versión 6.1 para esa API. Sin embargo, el comportamiento de la API será según la versión documentada 6.0.

IncludeValues

Tipo: booleano
Obligatoria: no
Predeterminado:

Permite especificar si se deben incluir los valores de las propiedades devueltas. True si se deben devolver valores con los metadatos; False para devolver solo los metadatos de propiedad.

ContinuationToken

Tipo: cadena
Obligatoria: no

El parámetro continuation token se utiliza para obtener el siguiente conjunto de resultados. Un token de continuación con un valor no vacío se incluye en la respuesta de la API cuando los resultados del sistema no caben en una única respuesta. Cuando este valor se pasa a la siguiente llamada de la API, la API devuelve el siguiente conjunto de resultados. Si no hay más resultados, el token de continuación no contiene ningún valor. El valor de este parámetro no debe ser la dirección URL codificada.

timeout

Tipo: entero (int64)
Obligatoria: no
Predeterminado:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tiempo de espera del servidor para realizar la operación en segundos. Este tiempo de espera especifica el tiempo que el cliente está dispuesto a esperar a que se complete la operación solicitada. El valor predeterminado para este parámetro es 60 segundos.

Respuestas

Código de estado HTTP Descripción Esquema de respuesta
200 (OK) Lista paginada de propiedades de Service Fabric.
 PagedPropertyInfoList
Todos los demás códigos de estado Respuesta de error detallada.
 FabricError

Ejemplos

Obtener lista de información de propiedades

En este ejemplo se muestra cómo obtener todas las propiedades de Service Fabric con un nombre determinado.

Request

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

Respuesta 200

Cuerpo
{
  "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"
      }
    }
  ]
}

Obtener la lista de información de propiedades con valores

En este ejemplo se muestra cómo obtener todas las propiedades de Service Fabric y sus valores con un nombre determinado.

Request

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

Respuesta 200

Cuerpo
{
  "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"
      }
    }
  ]
}

Página con token de continuación

En este ejemplo se muestra cómo paginar la información sobre las propiedades de un nombre de Service Fabric determinado mediante el parámetro ContinuationToken. El valor de este parámetro se proporciona a partir de la consulta anterior, en este caso, el ejemplo mostrado anteriormente. La respuesta contiene los dos resultados restantes y un ContinuationToken vacío. El objeto ContinuationToken vacío indica que los resultados adicionales no están disponibles.

Request

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

Respuesta 200

Cuerpo
{
  "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"
      }
    }
  ]
}