DeregisterInstance
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
Request Syntax
{ "InstanceId": "
string
", "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.
- InstanceId
-
The value that you specified for
Id
in the RegisterInstance request.Type: String
Length Constraints: Maximum length of 64.
Required: Yes
- ServiceId
-
The ID of the service that the instance is associated with.
Type: String
Length Constraints: Maximum length of 64.
Required: Yes
Response Syntax
{ "OperationId": "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.
- OperationId
-
A value that you can use to determine whether the request completed successfully. For more information, see GetOperation.
Type: String
Length Constraints: Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- DuplicateRequest
-
The operation is already in progress.
HTTP Status Code: 400
- InstanceNotFound
-
No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
HTTP Status Code: 400
- 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
- ResourceInUse
-
The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
HTTP Status Code: 400
- ServiceNotFound
-
No service exists with the specified ID.
HTTP Status Code: 400
Example
DeregisterInstance Example
Sample Request
POST / HTTP/1.1 host:servicediscovery.us-west-2.amazonaws.com x-amz-date:20181118T211816Z authorization: AWS4-HMAC-SHA256 Credential=AKIAIIO2CIV3EXAMPLE/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.DeregisterInstance content-type:application/x-amz-json-1.1 content-length:number of characters in the JSON string] { "InstanceId": "i-abcd1234", "ServiceId": "srv-e4anhexample0004" }
Sample Response
HTTP/1.1 200 Content-Length: 59 Content-Type: application/x-amz-json-1.1 { "OperationId":"httpvoqozuhfet5kzxoxg-a-response-example" }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: