Resolve Service
Resolve a Service Fabric partition.
Resolve a Service Fabric service partition to get the endpoints of the service replicas.
Request
| Method | Request URI |
|---|---|
| GET | /Services/{serviceId}/$/ResolvePartition?api-version=6.0&PartitionKeyType={PartitionKeyType}&PartitionKeyValue={PartitionKeyValue}&PreviousRspVersion={PreviousRspVersion}&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
serviceId |
string | Yes | Path |
api-version |
string | Yes | Query |
PartitionKeyType |
integer | No | Query |
PartitionKeyValue |
string | No | Query |
PreviousRspVersion |
string | No | Query |
timeout |
integer (int64) | No | Query |
serviceId
Type: string
Required: Yes
The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the "~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
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.
PartitionKeyType
Type: integer
Required: No
Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following.
- None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1.
- Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2.
- Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.
PartitionKeyValue
Type: string
Required: No
Partition key. This is required if the partition scheme for the service is Int64Range or Named.
This is not the partition ID, but rather, either the integer key value, or the name of the partition ID.
For example, if your service is using ranged partitions from 0 to 10, then they PartitionKeyValue would be an
integer in that range. Query service description to see the range or name.
PreviousRspVersion
Type: string
Required: No
The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale.
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 successful operation will return 200 status code. |
ResolvedServicePartition |
| All other status codes | The detailed error response. |
FabricError |