Share via

Get Sub Name Info List

  • Article

Enumerates all the Service Fabric names under a given name.

Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn't exist will fail.

Request

Method Request URI
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Parameters

Name Type Required Location
nameId string Yes Path
api-version string Yes Query
Recursive boolean No Query
ContinuationToken string No Query
timeout integer (int64) No Query

nameId

Type: string
Required: Yes

The Service Fabric name, without the 'fabric:' URI scheme.

api-version

Type: string
Required: Yes
Default: 6.0

The version of the API. This parameter is required and its value must be '6.0'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

Recursive

Type: boolean
Required: No
Default: false

Allows specifying that the search performed should be recursive.

ContinuationToken

Type: string
Required: No

The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.

timeout

Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Responses

HTTP Status Code Description Response Schema
200 (OK) A paged list of Service Fabric names.
 PagedSubNameInfoList
All other status codes The detailed error response.
 FabricError

Examples

Get sub names

This example shows how to get information about all sub names of a given Service Fabric name.

Request

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

200 Response

Body
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/mynames"
  ]
}

Recursively search sub names

This example shows how to recursively get information about all child sub names of a given Service Fabric name.

Request

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True

200 Response

Body
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps",
    "fabric:/samples/data",
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/CalculatorApp/CalculatorService",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
    "fabric:/samples/mynames/name-1"
  ]
}

Page using continuation token

This example shows how to page through the information about sub names under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.

Request

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

200 Response

Body
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps/VolatileQueueApp",
    "fabric:/samples/apps/NotepadApp"
  ]
}