获取API 端点列表信息。
接口说明
用于获取 API 端点列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ApiDestinationNamePrefix | string | 否 | API 端点名称前缀。 | api-demo |
ConnectionName | string | 否 | 连接配置名称。 | connection-name |
MaxResults | long | 否 | 限定每次返回的最大条数,可以和 nextToken 搭配使用实现翻页能力。 默认值是 10。 | 10 |
NextToken | string | 否 | 当指定 MaxResults 时,如果还有多余的返回值则会返回 NextToken。 NextToken 值默认是从 0 开始计算的,默认值是 0。 | 0 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "96D7C0AB-DCE5-5E82-96B8-4725E170****",
"Message": "success",
"Code": "Success",
"Data": {
"ApiDestinations": [
{
"ApiDestinationName": "api-destination-2",
"ConnectionName": "connection-name",
"Description": "demo",
"HttpApiParameters": {
"Endpoint": "http://127.0.0.1:8001/api",
"Method": "POST"
},
"GmtCreate": 1665223213000
}
],
"NextToken": "1",
"Total": 2,
"MaxResults": 10
}
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
409 | RequestParameterException | Request parameter exception |
500 | InternalError | InternalError |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||
| ||||||||||||||
2023-04-06 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||
|