Updates an API destination.
Operation description
You can call this API operation to update an API destination.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Description | string | No | The description of the API destination. The description can be up to 255 characters in length. | demo |
| ApiDestinationName | string | Yes | The name of the API destination. The name must be 2 to 127 characters in length. | api-destination-name |
| ConnectionName | string | Yes | The name of the connection. The name must be 2 to 127 characters in length. Note: Before you configure this parameter, you must call the CreateConnection operation to create a connection. Then, set this parameter to the name of the connection that you created. | connection-name |
| HttpApiParameters | object | Yes | The parameters that are configured for the API destination. | |
| Endpoint | string | Yes | The endpoint of the API destination. The endpoint can be up to 127 characters in length. | http://127.0.0.1:8001/api |
| Method | string | Yes | The HTTP request method. Valid values:
| POST |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "382E6272-8E9C-5681-AC96-A8AF0BFAC1A5",
"Message": "success",
"Code": "Success",
"ApiDestinationName": "api-destination-name"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 409 | RequestParameterException | Request parameter exception |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-09-13 | The Error code has changed | see changesets | ||||||
| ||||||||
| 2023-04-12 | The Error code has changed | see changesets | ||||||
| ||||||||
| 2023-04-06 | The Error code has changed | see changesets | ||||||
|