この操作では、アラートコンタクトグループの一覧を照会します。
デバッグ
API Explorer を使用してデバッグを実行できます。 API Explorer を使用することで、さまざまな操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。
リクエストパラメーター
| パラメーター | データ型 | 必須/省略可能 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | 必須 | DescribeContactGroupList |
実行する操作。 値を DescribeContactGroupList に設定します。 |
| PageNumber | Integer | 省略可能 | 10 |
ページの番号。 |
| PageSize | Integer | 省略可能 | 1 |
各ページのレコード数。 |
レスポンスパラメーター
| パラメーター | データ型 | 例 | 説明 |
|---|---|---|---|
| Code | String | 200 |
ステータスコード。 値が 200 の場合、呼び出しが成功したことを示します。 |
| ContactGroups | Alert contact group list |
アラート連絡先グループの一覧。 |
|
| Message | String | Error message |
エラーメッセージ。 |
| RequestId | String | 916EE694-03C2-47B6-85EE-5054E3C168D3 |
トラブルシューティングのリクエスト ID。 |
| Success | Boolean | true |
呼び出しが成功したかを示します。 値が true の場合、呼び出しが成功したことを示します。 値が false の場合、呼び出しが失敗したことを示します。 |
| Total | Integer | 22 |
返されるレコードの総数。 |
例
リクエスト例
http(s)://[Endpoint]/? Action=DescribeContactGroupList
&<Common request parameters>
通常のレスポンス例
XML形式
<DescribeContactGroupListResponse>
<Code>200</Code>
<ContactGroups>My alert contact group 1</ContactGroups>
<RequestId>916EE694-03C2-47B6-85EE-5054E3C168D3</RequestId>
<Success>true</Success>
<Total>22</Total>
</DescribeContactGroupListResponse>
JSON 形式
{
"RequestId":"916EE694-03C2-47B6-85EE-5054E3C168D3",
"ContactGroup":[
"My alert contact group 1"
],
"Success":true,
"Code": "200"
"Total":20
}