API 宛先を更新します。
操作説明
この API オペレーションを呼び出して、API 宛先を更新できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
eventbridge:UpdateApiDestination |
update |
*ApiDestination
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Description |
string |
任意 |
API 宛先の説明。説明の長さは 255 文字までです。 |
demo |
| ApiDestinationName |
string |
必須 |
API 宛先の名前。名前の長さは 2~127 文字である必要があります。 |
api-destination-name |
| ConnectionName |
string |
任意 |
接続の名前。名前の長さは 2~127 文字である必要があります。 注意:このパラメーターを設定する前に、CreateConnection オペレーションを呼び出して接続を作成する必要があります。その後、このパラメーターを作成した接続の名前に設定します。 |
connection-name |
| HttpApiParameters |
object |
任意 |
API 宛先に設定されるパラメーター。 |
|
| Endpoint |
string |
任意 |
API 宛先のエンドポイント。エンドポイントの長さは 127 文字までです。 |
http://127.0.0.1:8001/api |
| Method |
string |
任意 |
HTTP リクエストメソッド。有効な値:
|
POST |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
382E6272-8E9C-5681-AC96-A8AF0BFAC1A5 |
| Message |
string |
返されたメッセージ。リクエストが成功した場合、「success」が返されます。 |
success |
| Code |
string |
応答コード。リクエストが成功した場合、「Success」が返されます。 |
Success |
| ApiDestinationName |
string |
API 宛先の名前。 |
api-destination-name |
例
成功レスポンス
JSONJSON
{
"RequestId": "382E6272-8E9C-5681-AC96-A8AF0BFAC1A5",
"Message": "success",
"Code": "Success",
"ApiDestinationName": "api-destination-name"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 500 | InternalError | InternalError | |
| 409 | RequestParameterException | Request parameter exception | |
| 409 | ApiDestinationNotExist | The api-destination not existed! | |
| 409 | HttpApiParametersIsNull | HttpApiParameters is null! | |
| 409 | EndpointIsBlank | Endpoint is blank! | |
| 409 | Method | Method is blank! | |
| 409 | EndpointLengthExceed | Endpoint length cannot exceed 127! | |
| 409 | ConnectionNotExist | The Connection not existed! |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。