更新API 端点。
接口说明
用于更新 API 端点相关配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Description | string | 否 | API 端点描述信息，最大长度 255 个字符。 | demo |
| ApiDestinationName | string | 是 | 需要更新的 API 端点名称，最大长度 127 个字符。最小长度 2 个字符。 | api-destination-name |
| ConnectionName | string | 否 | 连接配置名称。最大长度 127 个字符。最小长度 2 个字符。 提示 ： 需要先调用 Connection 接口创建连接配置，ConnectionName 填写已存在的连接名称 | connection-name |
| HttpApiParameters | object | 否 | API 端点的配置信息 | |
| Endpoint | string | 否 | API 端点的接入点地址。最大长度 127 个字符。 | http://127.0.0.1:8001/api |
| Method | string | 否 | HTTP 请求方法。
| POST |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "382E6272-8E9C-5681-AC96-A8AF0BFAC1A5",
"Message": "success",
"Code": "Success",
"ApiDestinationName": "api-destination-name"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 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! |
| 500 | InternalError | InternalError |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-09-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
| 2023-04-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
| 2023-04-06 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|