post X Amz Target StorageGateway 20130630 StartAvailabilityMonitorTest - storagegateway API | Specway Docs

Own AWS? Customize your docs with AI search, analytics, and more.

Claim your docs

POST

/#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest

http://storagegateway.{region}.amazonaws.com/#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest

<p>Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the <code>DescribeAvailabilityMonitorTest</code> API.</p> <note> <p>Starting this test will cause your gateway to go offline for a brief period.</p> </note>

Access Token Required: API Key

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://storagegateway.{region}.amazonaws.com/#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

Own AWS? Customize your docs with AI search, analytics, and more.

Claim your docs

POST

/#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest

http://storagegateway.{region}.amazonaws.com/#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest

<p>Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the <code>DescribeAvailabilityMonitorTest</code> API.</p> <note> <p>Starting this test will cause your gateway to go offline for a brief period.</p> </note>

Access Token Required: API Key

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://storagegateway.{region}.amazonaws.com/#X-Amz-Target=StorageGateway_20130630.StartAvailabilityMonitorTest' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}