Get all instance metadata of a Consul service
GET /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/consul/datacenters/{consul_datacenter}/services/{consul_service}/instances_metadata
GET /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/consul/datacenters/{consul_datacenter}/services/{consul_service}/instances_metadataInteractive request editor loads with JavaScript.
X-API-KEY<token>
In: header
Path Parameters
service_registry_id*string
Service registry ID.
Length
1 <= lengthgateway_group_id*string
Gateway group ID.
Length
1 <= lengthconsul_datacenter*string
Consul datacenter name.
Length
1 <= lengthconsul_service*string
Consul service name.
Length
1 <= lengthResponse Body
application/json
curl -X GET "$API_BASE_URL/api/gateway_groups/86fb9981-d9d2-4555-9df8-91ae92129335/service_registries/86fb9981-d9d2-4555-9df8-91ae92129335/consul/datacenters/dc1/services/web/instances_metadata"Successfully retrieved the Consul service instance metadata.
{
"value": {
"version": [
"1.0.0",
"1.0.1"
],
"env": [
"prod",
"staging"
]
}
}Invalid arguments. Error details will be provided in the response.
Complete operation details and schema variants
GET /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/consul/datacenters/{consul_datacenter}/services/{consul_service}/instances_metadata
Get all instance metadata of a Consul service
IAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
Parameters
service_registry_id(path, string, required): Service registry ID.gateway_group_id(path, string, required): Gateway group ID.consul_datacenter(path, string, required): Consul datacenter name.consul_service(path, string, required): Consul service name.
Responses
200: Successfully retrieved the Consul service instance metadata.- allOf variant 1
value(object, optional): The specific resource.- allOf variant 2
value(object, optional): An object of Consul service instance metadata.400: Invalid arguments. Error details will be provided in the response.
cURL
curl -X GET '$API_BASE_URL/api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/consul/datacenters/{consul_datacenter}/services/{consul_service}/instances_metadata'