Classic/VPC環境で利用できます。
メール送信プロジェクトごとに設定項目を照会します。現在は送信遮断内訳のみ閲覧できます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /config |
リクエストヘッダ
Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
String | Required | 照会対象の設定項目
|
subType |
String | Optional | 設定のサブタイプ
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/config
?type=SEND_BLOCK_TIME'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
String | Required | 照会した設定項目 |
subType |
Integer | Optional | 設定のサブタイプ |
value |
String | Required | 反映された設定値 |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
| HTTPステータスコード | コード | 説明 |
|---|---|---|
| 200 | - | リクエスト成功 |
| 400 | - | 認証失敗、無効なリクエスト |
| 400 | 77101 | ログイン情報エラー |
| 400 | 77102 | リクエストエラー |
| 400 | 77103 | リクエストしたリソースが存在しない |
| 403 | 77201 | リクエストしたリソースに対する権限がない |
| 403 | 77202 | メールサービスの使用を申し込んでいないユーザーが呼び出した場合 |
| 405 | 77001 | サポートしないメソッドタイプ |
| 415 | 77002 | サポートしないメディアタイプ |
| 500 | - | サーバエラー |
| 500 | 77301 | 基本プロジェクトが存在しない |
| 500 | 77302 | 外部システム API連携エラー |
| 500 | 77303 | その他の内部サーバエラー |
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"type": "SEND_BLOCK_TIME",
"subType": null,
"value": "180"
}