GetServiceAttributes
Returns the attributes associated with a specified service.
Request Syntax
{
"ServiceId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ServiceId
-
The ID of the service that you want to get attributes for.
Type: String
Length Constraints: Maximum length of 64.
Required: Yes
Response Syntax
{
"ServiceAttributes": {
"Attributes": {
"string" : "string"
},
"ServiceArn": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ServiceAttributes
-
A complex type that contains the service ARN and a list of attribute key-value pairs associated with the service.
Type: ServiceAttributes object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInput
-
One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
HTTP Status Code: 400
- ServiceNotFound
-
No service exists with the specified ID.
HTTP Status Code: 400
Examples
GetServiceAttributes Example for service with an attribute
The following API request retrieves attributes for the service srv-e4anhexample0004. The service has the attribute Port with the value 80.
Sample Request
POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20241223T173136Z
authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request,
SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
Signature=[calculated-signature]
x-amz-target:Route53AutoNaming_v20170314.GetServiceAttributes
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
"ServiceId": "srv-e4anhexample0004"
}Sample Response
HTTP/1.1 200
Content-Length: [number of characters in the JSON string]
Content-Type: application/x-amz-json-1.1
{
"ServiceAttributes": {
"ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0004",
"Attributes": {
"Port": "80"
}
}
}GetServiceAttributes Example for service without attributes
The following API request demonstrates the response returned when a service does not have any attributes associated with it.
Sample Request
POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20241223T173136Z
authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request,
SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
Signature=[calculated-signature]
x-amz-target:Route53AutoNaming_v20170314.GetServiceAttributes
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
"ServiceId": "srv-e4anhexample0005"
}Sample Response
HTTP/1.1 200
Content-Length: [number of characters in the JSON string]
Content-Type: application/x-amz-json-1.1
{
"ServiceAttributes": {
"ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-e4anhexample0005",
"Attributes": {}
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
