バッチでのサイトモニタリングタスクの作成 - CMS

操作説明

このトピックでは、HangZhou_ECS1 という名前のサイトモニタリングタスクを作成する例を示します。このタスクは、HTTP プロトコルを使用して https://www.aliyun.com をモニターします。応答では、タスクが HangZhou_ECS1 という名前と ID 679fbe4f-b80b-4706-91b2-5427b43e**** で正常に作成されたことが示されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:BatchCreateInstantSiteMonitor

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskList	array<object>	必須	サイトモニタリングタスクのリストです。説明少なくとも 1 つのサイトモニタリングタスクを作成する必要があります。 `Address`、`TaskName`、および `TaskType` パラメーターは必須です。
	object	任意	サイトモニタリングタスクのリストです。
Address	string	任意	サイトモニタリングタスクの URL または IP アドレスです。説明少なくとも 1 つのサイトモニタリングタスクを作成する必要があります。 `Address`、`TaskName`、および `TaskType` パラメーターは必須です。	https://www.aliyun.com
IspCities	string	任意	探測点の情報です。このパラメーターを空のままにすると、システムはランダムに 3 つの探測点を選択します。値は `JSONArray` である必要があります。たとえば、`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]` は、北京、杭州、青島に対応します。探測点の情報の取得方法の詳細については、「DescribeSiteMonitorISPCityList」をご参照ください。	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	任意	サイトモニタリングタスクのプロトコルタイプの高度な拡張オプションです。プロトコルタイプごとに、対応する拡張オプションが異なります。	{"time_out":5000}
TaskName	string	任意	サイトモニタリングタスクの名前です。サイトモニタリングタスクの名前です。説明少なくとも 1 つのサイトモニタリングタスクを作成する必要があります。 `Address`、`TaskName`、および `TaskType` パラメーターは必須です。	HangZhou_ECS1
TaskType	string	任意	モニタリングタスクのプロトコルタイプです。有効な値： HTTP、PING、TCP、UDP、DNS、SMTP、POP3、FTP。説明少なくとも 1 つのサイトモニタリングタスクを作成する必要があります。 `Address`、`TaskName`、および `TaskType` パラメーターは必須です。	HTTP

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
RequestId	string	リクエスト ID です。	7AE72720-2C96-5446-9F2B-308C7CEDFF1A
Message	string	返されたメッセージです。	successful
Success	boolean	操作が成功したかどうかを示します。有効な値： true：操作は成功しました。 false：操作は失敗しました。	true
Data	array<object>	サイトモニタリングタスクに関する情報です。	[{"taskName": "HangZhou_ECS1", "taskId": "679fbe4f-b80b-4706-91b2-5427b43e****"}]
	object	サイトモニタリングタスクに関する情報です。
TaskName	string	サイトモニタリングタスクの名前です。	HangZhou_ECS1
TaskId	string	サイトモニタリングタスクの ID です。	679fbe4f-b80b-4706-91b2-5427b43e****
Code	string	ステータスコードです。説明値が 200 の場合、リクエストは成功です。	200

例

成功レスポンス

JSONJSON

{
  "RequestId": "7AE72720-2C96-5446-9F2B-308C7CEDFF1A",
  "Message": "successful",
  "Success": true,
  "Data": [
    {
      "TaskName": "HangZhou_ECS1",
      "TaskId": "679fbe4f-b80b-4706-91b2-5427b43e****"
    }
  ],
  "Code": "200"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameterValue	Illegal parameters.	不正なパラメータ。
400	ParameterInvalid	The parameter is missing or invalid. %s
403	Forbidden	You are not authorized to operate the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
429	ResourceOverLimit	The resource has exceeded the limit. %s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。