vapi metadata routing component: get
Get the routing information for a vAPI component
Request:
HTTP request
GET https://{server}/rest/com/vmware/vapi/metadata/routing/component/id:{component_id}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| component_id | string | fully qualified component name. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"fingerprint" : "string",
"info" : {
"packages" : [
{
"value" : {
"routing_info" : {
"operation_hints" : [
"string",
"string"
],
"id_types" : [
{
"value" : "string",
"key" : "string"
}
],
"routing_strategy" : "string",
"routing_path" : "string"
},
"services" : [
{
"value" : {
"operations" : [
{
"value" : {
"routing_info" : {
"operation_hints" : [
"string",
"string"
],
"id_types" : [
{
"value" : "string",
"key" : "string"
}
],
"routing_strategy" : "string",
"routing_path" : "string"
}
},
"key" : "obj-103"
}
],
"routing_info" : {
"operation_hints" : [
"string",
"string"
],
"id_types" : [
{
"value" : "string",
"key" : "string"
}
],
"routing_strategy" : "string",
"routing_path" : "string"
}
},
"key" : "obj-103"
}
]
},
"key" : "obj-103"
}
]
}
}
}
"value" : {
"fingerprint" : "string",
"info" : {
"packages" : [
{
"value" : {
"routing_info" : {
"operation_hints" : [
"string",
"string"
],
"id_types" : [
{
"value" : "string",
"key" : "string"
}
],
"routing_strategy" : "string",
"routing_path" : "string"
},
"services" : [
{
"value" : {
"operations" : [
{
"value" : {
"routing_info" : {
"operation_hints" : [
"string",
"string"
],
"id_types" : [
{
"value" : "string",
"key" : "string"
}
],
"routing_strategy" : "string",
"routing_path" : "string"
}
},
"key" : "obj-103"
}
],
"routing_info" : {
"operation_hints" : [
"string",
"string"
],
"id_types" : [
{
"value" : "string",
"key" : "string"
}
],
"routing_strategy" : "string",
"routing_path" : "string"
}
},
"key" : "obj-103"
}
]
},
"key" : "obj-103"
}
]
}
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | component_data | routing information for the vAPI component. |
| value.info | component_info | Routing information of the vAPI component |
| value.info.packages | list | Routing information of all the vAPI packages. The key in the map is the ID of the package and the value in the map is the routing information for the package For an explanation of routing information within packages, see vapi.metadata.routing.package When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vapi.package. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vapi.package.List of {"key": string, "value": package_info} |
| value.info.packages[].key | string | |
| value.info.packages[].value | package_info | |
| value.info.packages[].value.routing_info | routing_info | The routing information to be used for all the operations present in this package. If a particular operation has no explicit routing information defined in the routing definition file, this routing info will be used for enforcing routing. |
| value.info.packages[].value.routing_info.routing_path | string | The initial version of the routing info allowed routing by single parameter. Clients requested allowing them to place more than one parameters so that the routing is performed by the first non-null argument in the list. To achieve that we have added method com.vmware.vapi.metadata.RoutingInfo#getRoutingPaths() which should be preferred over com.vmware.vapi.metadata.RoutingInfo#getRoutingPath() which is deprecated. The deprecated method will return string representation of the comma-separated list of ids, while the com.vmware.vapi.metadata.RoutingInfo#getRoutingPaths() will return instance of java.util.List<String> containing the ids. |
| value.info.packages[].value.routing_info.routing_strategy | string | The routingStrategy is the actual strategy, based on which will be performed the routing. If the routingStrategy is IDROUTE, in vapi.metadata.routing.routing_info.routing_path must be assigned the id for the routing. There are also default strategies like IDFIRSTROUTE, LOCAL for which there is no need to specify routingPath. The name of these strategies is clear about where we should look for an ID to route, or if we need ID at all. |
| value.info.packages[].value.routing_info.operation_hints | string[] | This is comma-separated list of hints from the input ini file. Here the user must mention the type of the invoked method, e.g. HINTS(create) or HINTS(delete). In the future we expect this field to contain other hints also e.g. HINTS(create,lazy). |
| value.fingerprint | string | Fingerprint of metadata of a vAPI component |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | If the component name does not exist |