Dapatkan Daftar Info Properti

Mendapatkan informasi tentang semua properti Service Fabric dengan nama tertentu.

Nama Service Fabric dapat memiliki satu atau beberapa properti bernama yang menyimpan informasi kustom. Operasi ini mendapatkan informasi tentang properti ini dalam daftar halaman. Informasi ini mencakup nama, nilai, dan metadata tentang masing-masing properti.

Minta

Metode	URI Permintaan
GET	/Names/{nameId}/$/GetProperties?api-version=6.0&IncludeValues={IncludeValues}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parameter

Nama	Jenis	Diperlukan	Lokasi
nameId	string	Ya	Jalur
api-version	string	Ya	Kueri
IncludeValues	boolean	Tidak	Kueri
ContinuationToken	string	Tidak	Kueri
timeout	bilangan bulat (int64)	Tidak	Kueri

---

nameId

Jenis: string
Diperlukan: Ya

Nama Service Fabric, tanpa skema URI 'fabric:'.

---

api-version

Jenis: string
Diperlukan: Ya
Default: 6.0

Versi API. Parameter ini diperlukan dan nilainya harus '6.0'.

Versi REST API Service Fabric didasarkan pada versi runtime tempat API diperkenalkan atau diubah. Runtime Service Fabric mendukung lebih dari satu versi API. Ini adalah versi API terbaru yang didukung. Jika versi API yang lebih rendah diteruskan, respons yang dikembalikan mungkin berbeda dari yang di dokumentasikan dalam spesifikasi ini.

Selain itu runtime menerima versi apa pun yang lebih tinggi dari versi terbaru yang didukung hingga versi runtime saat ini. Jadi, jika versi API terbaru adalah 6.0, tetapi jika runtime adalah 6.1, untuk mempermudah penulisan klien, runtime akan menerima versi 6.1 untuk API tersebut. Namun perilaku API akan sesuai dengan versi 6.0 yang di dokumentasikan.

---

IncludeValues

Jenis: boolean
Diperlukan: Tidak
Default: false

Memungkinkan menentukan apakah akan menyertakan nilai properti yang dikembalikan. True jika nilai harus dikembalikan dengan metadata; False untuk mengembalikan metadata properti saja.

---

ContinuationToken

Jenis: string
Diperlukan: Tidak

Parameter token kelanjutan digunakan untuk mendapatkan serangkaian hasil berikutnya. Token kelanjutan dengan nilai tidak kosong disertakan dalam respons API ketika hasil dari sistem tidak sesuai dalam respons tunggal. Ketika nilai ini diteruskan ke panggilan API berikutnya, API mengembalikan serangkaian hasil berikutnya. Jika tidak ada hasil lebih lanjut, maka token kelanjutan tidak berisi nilai. Nilai parameter ini tidak boleh dikodekan URL.

---

timeout

Jenis: bilangan bulat (int64)
Diperlukan: Tidak
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Batas waktu server untuk melakukan operasi dalam hitungan detik. Batas waktu ini menentukan durasi waktu klien bersedia menunggu operasi yang diminta selesai. Nilai default untuk parameter ini adalah 60 detik.

Respons

Kode Status HTTP	Deskripsi	Skema Respons
200 (OK)	Daftar halaman properti Service Fabric.	PagedPropertyInfoList
Semua kode status lainnya	Respons kesalahan terperinci.	FabricError

Contoh

Dapatkan daftar info properti

Contoh ini menunjukkan cara mendapatkan semua properti Service Fabric dengan nama tertentu.

Minta

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

Respons 200

Isi

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

Mendapatkan daftar info properti dengan nilai

Contoh ini menunjukkan cara mendapatkan semua properti Service Fabric dan nilainya dengan nama tertentu.

Minta

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

Respons 200

Isi

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

Halaman menggunakan token kelanjutan

Contoh ini menunjukkan cara halaman melalui informasi tentang properti di bawah nama Service Fabric tertentu menggunakan parameter ContinuationToken. Nilai parameter ini disediakan dari kueri sebelumnya, dalam hal ini contoh yang ditunjukkan di atas. Respons berisi dua hasil yang tersisa dan ContinuationToken kosong. ContinuationToken kosong menunjukkan bahwa hasil tambahan tidak tersedia.

Minta

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

Respons 200

Isi

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