オリジンプロービングタスクを作成します。
説明
CreateApplicationMonitor操作を呼び出して、オリジンプロービングタスクを作成できます。 オリジンプロービングタスクは、クライアントとオリジンサーバー間のネットワーク品質を監視し、オリジンの可用性をチェックします。
この操作を呼び出す前に、次の項目に注意してください。
- CreateApplicationMonitorは非同期操作です。 リクエストを送信した後、システムはオリジンプロービングタスクのIDを返しますが、オリジンプロービングタスクはシステムのバックグラウンドでまだ作成されています。
DescribeApplicationMonitorまたはListApplicationMonitor操作を呼び出して、オリジンプロービングタスクの状態を照会できます。
- オリジンプロービングタスクがinit状態の場合、タスクが作成中であることを示します。 この場合、クエリ操作のみを実行できます。
- オリジンプロービングタスクがアクティブ状態の場合、タスクが作成されたことを示します。
- CreateApplicationMonitor操作は、特定の期間内に同じGlobal Accelerator (GA) インスタンスに対して繰り返し呼び出すことはできません。
デバッグ
OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorerは、さまざまなSDKの操作のサンプルコードを動的に生成します。
リクエストパラメーター
| 項目 | データ型 | 必須／任意 | 例: | 説明 |
|---|---|---|---|---|
| 操作 | String | 必須 | CreateApplicationMonitor |
実行する操作です。 値をCreateApplicationMonitorに設定します。 |
| RegionId | String | 必須 | cn-hangzhou |
GAインスタンスがデプロイされているリージョンのID。 値をcn-hangzhouに設定します。 |
| ClientToken | String | 任意 | 123e4567-e89b-12d3-a456-426655440000 |
リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 ClientTokenにはASCII文字のみを含めることができます。 説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 RequestIdの値は、APIリクエストごとに異なる場合があります。
|
| AcceleratorId | String | 必須 | ga-bp1odcab8tmno0hdq**** |
オリジンプロービングタスクを実行するGAインスタンスのID。 |
| ListenerId | String | 必須 | lsr-bp1bpn0kn908w4nbw**** |
オリジンプロービングタスクを実行するリスナーのID。 |
| TaskName | String | 必須 | task1 |
オリジンプロービングタスクの名前。 名前は4 ~ 100文字で、数字、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は文字である必要があります。 |
| アドレス | String | 必須 | https://www.aliyun.com |
プローブするURLまたはIPアドレス。 |
| OptionsJson | String | 任意 | null |
オリジンプロービングタスクで使用されるリスナープロトコルの拡張オプション。 オプションは、リスナープロトコルによって異なります。 |
| DetectEnable | Boolean | いいえ | false |
自動診断機能を有効にするかどうかを指定します。 デフォルト値：false 有効な値：
|
| DetectThreshold | Integer | いいえ | 0 |
自動診断機能のトリガーに使用されるしきい値。 単位: % 。 有効な値: 0〜100。 デフォルト値は0です。これは、自動診断機能がトリガーされていないことを示します。 |
| DetectTimes | Integer | いいえ | 1 |
自動診断機能がトリガーされる前にしきい値に到達するのに必要な回数。 有効な値: 1〜20。 デフォルト値: 1 |
| SilenceTime | Integer | いいえ | 300 |
自動診断機能の無音期間。 このパラメーターは、自動診断機能がトリガーされる間隔を指定します。 GAが自動診断をトリガした後に可用性レートが正常に戻らない場合、GAが別の自動診断をトリガできるようになる前に、GAは無音期間が終了するまで待たなければならない。 稼働率が自動診断のしきい値を下回った連続回数がDetectTimesパラメーターの値に達すると、自動診断機能がトリガーされます。 自動診断機能は、可用性レートがしきい値未満のままであっても、無音期間内に再びトリガされることはない。 無音期間が終了した後に可用性レートが正常に戻らない場合、自動診断機能が再びトリガされる。 単位：秒。 有効な値: 300〜86400。 デフォルト値: 300 |
レスポンスパラメーター
| 項目 | データ型 | 例: | 説明 |
|---|---|---|---|
| RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 |
リクエストの ID です。 |
| TaskId | String | sm-bp1fpdjfju9k8yr1y **** |
オリジンプロービングタスクのID。 |
例
リクエストの例
http(s)://[Endpoint]/?Action=CreateApplicationMonitor
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp1odcab8tmno0hdq ****
&ListenerId=lsr-bp1bpn0kn908w4nbw ****
&TaskName=task1
&住所=https://www.aliyun.com
&OptionsJson={ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true}
&DetectEnable=false
&DetectThreshold=0
&DetectTimes=1
&SilenceTime=300
&共通リクエストパラメータ正常に処理された場合のレスポンス例
XML 形式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateApplicationMonitorResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
<TaskId>sm-bp1fpdjfju9k8yr1y ****</TaskId>
</CreateApplicationMonitorResponse>JSON 形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368" 、
"TaskId" : "sm-bp1fpdjfju9k8yr1y ****"
}エラーコード
| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | NotExist.Listener | リスナーが存在しません。 | 指定されたリスナーが存在しない場合に返されるエラーメッセージ。 |
エラーコードリストについては、「API エラーセンター」をご参照ください。