指定されたパラメータに基づいてヘルスチェックテンプレートを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
alidns:ListCloudGtmMonitorTemplates |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AcceptLanguage |
string |
任意 |
レスポンスの言語。有効な値:
|
zh-CN |
| PageNumber |
integer |
必須 |
ページ番号。値は 1 から始まります。デフォルト値は 1 です。 |
1 |
| PageSize |
integer |
必須 |
各ページに返すエントリの数。最大値:100。デフォルト値:20。 |
20 |
| Name |
string |
任意 |
ヘルスチェックテンプレートの名前。異なるヘルスチェックプロトコルを区別しやすいようにテンプレートに名前を付けます。 |
IPv4-Ping |
| IpVersion |
string |
任意 |
検出ポイントの IP バージョン。
|
IPv4 |
| Protocol |
string |
任意 |
ヘルスチェックに使用されるプロトコル。
|
ping |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
一意のリクエスト ID。 |
75446CC1-FC9A-4595-8D96-089D73D7A63D |
| TotalPages |
integer |
返されるページの総数。 |
2 |
| TotalItems |
integer |
ヘルスチェックテンプレートの総数。 |
30 |
| PageSize |
integer |
各ページに返されるエントリの数。最大値:100。デフォルト値:20。 |
20 |
| PageNumber |
integer |
返されたページの番号。ページは 1 から始まります。デフォルト値:1。 |
1 |
| Templates |
object |
||
| Template |
array<object> |
ヘルスチェックテンプレートのリスト。 |
|
|
object |
ヘルスチェックテンプレートの詳細。 |
||
| TemplateId |
string |
ヘルスチェックテンプレートの一意の ID。 |
mtp-89518052425100**** |
| CreateTime |
string |
ヘルスチェックテンプレートが作成された日時。 |
2024-03-23T13:09Z |
| CreateTimestamp |
integer |
ヘルスチェックテンプレートが作成された日時を示すタイムスタンプ。 |
1527690629357 |
| UpdateTime |
string |
ヘルスチェックテンプレートが最後に変更された日時。 |
2024-03-29T13:20Z |
| UpdateTimestamp |
integer |
ヘルスチェックテンプレートが最後に変更された日時を示すタイムスタンプ。 |
1527690629357 |
| Name |
string |
ヘルスチェックテンプレートの名前。 |
IPv4-Ping |
| IpVersion |
string |
検出ポイントの IP バージョン。
|
IPv4 |
| Protocol |
string |
ヘルスチェックに使用されるプロトコル。
|
ping |
| Interval |
integer |
ヘルスチェックの間隔(秒)。デフォルト値は 60 です。15 秒の最小間隔は、Ultimate エディションインスタンスでのみ使用できます。 |
60 |
| Timeout |
integer |
ヘルスチェックのタイムアウト期間(ミリ秒)。この期間内にレスポンスが受信されない場合、ヘルスチェックはタイムアウトしたとみなされます。有効な値:
|
5000 |
| EvaluationCount |
integer |
システムがサービスを異常と宣言する前にヘルスチェックが連続して失敗する必要がある回数。これは、ネットワークジッターによる誤ったアラームを防ぐのに役立ちます。有効な値:
|
2 |
| FailureRate |
integer |
故障率のしきい値。異常な検出ポイントの割合がこのしきい値を超えると、システムはエンドポイントを異常と宣言します。有効な値:
|
50 |
| ExtendInfo |
string |
JSON 文字列の拡張情報。使用可能なパラメータは、プロトコルによって異なります。
|
{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"} |
| IspCityNodes |
object |
||
| IspCityNode |
array<object> |
検出ポイントのリスト。詳細については、「ListCloudGtmMonitorNodes」をご参照ください。 |
|
|
object |
検出ポイント。 |
||
| CountryCode |
string |
国別コード。 |
001 |
| CountryName |
string |
国名。 |
中国 |
| CityCode |
string |
都市コード。 |
503 |
| CityName |
string |
都市名。 |
张家口市 |
| GroupType |
string |
検出ポイントグループの種類。
|
BGP |
| GroupName |
string |
検出ポイントグループの名前。 |
BGP节点 |
| IspCode |
string |
キャリアコード。 |
465 |
| IspName |
string |
キャリア名。 |
阿里巴巴 |
| Remark |
string |
ヘルスチェックテンプレートに関する備考。 |
test |
例
成功レスポンス
JSONJSON
{
"RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
"TotalPages": 2,
"TotalItems": 30,
"PageSize": 20,
"PageNumber": 1,
"Templates": {
"Template": [
{
"TemplateId": "mtp-89518052425100****",
"CreateTime": "2024-03-23T13:09Z",
"CreateTimestamp": 1527690629357,
"UpdateTime": "2024-03-29T13:20Z",
"UpdateTimestamp": 1527690629357,
"Name": "IPv4-Ping",
"IpVersion": "IPv4",
"Protocol": "ping",
"Interval": 60,
"Timeout": 5000,
"EvaluationCount": 2,
"FailureRate": 50,
"ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}\n",
"IspCityNodes": {
"IspCityNode": [
{
"CountryCode": "001",
"CountryName": "中国",
"CityCode": "503",
"CityName": "张家口市",
"GroupType": "BGP",
"GroupName": "BGP节点",
"IspCode": "465",
"IspName": "阿里巴巴"
}
]
},
"Remark": "test"
}
]
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。