获取API 端点列表信息。
接口说明
用于获取 API 端点列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| eventbridge:ListApiDestinations | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 返回结构发生变更 | 查看变更详情 |