获取servicebridge列表 - ListServiceBridges
功能介绍
获取servicebridge列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/fgs/servicebridge
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目 ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | String | 偏移量,表示从此偏移量开始查询。 |
| limit | 否 | String | 每次查询获取的最大记录数量 最大值:400 如果不提供该值或者提供的值大于400或等于0,则使用默认值:400 如果该值小于0,则返回参数错误。 |
| bridge_name | 否 | String | servicebridge名称(支持模糊匹配)。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 否 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 只能为application/json 默认取值: application/json |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| service_bridges | Array of ListBridgeResult objects | servicebridge列表。 |
| next_marker | Long | bridge下次记录读取位置。 |
| count | Long | 满足查询条件的bridge总数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 租户id。 |
| bridge_name | String | servicebridge名称。 |
| bridge_config | BridgeConfig object | servicebridge配置结构体。 |
| bridge_id | String | bridge id,唯一标识。 |
| xrole | String | 函数配置委托。需要IAM支持,并在IAM界面创建委托,当函数需要访问其他服务时,必须提供该字段。配置后用户可以通过函数执行入口方法中的context参数获取具有委托中权限的token、ak、sk,用于访问其他云服务。如果用户函数不访问任何云服务,则不用提供委托名称。 |
| bridge_vpc | FuncVpc object | 函数vpc配置。需同时为函数配置具有vpc权限的委托。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data_source_type | String | bridge类型,支持rds,cache,mqs,mqs-consumer。 |
| rds_config | RdsConfig object | rds型bridge配置结构体。 |
| cache_config | CacheConfig object | cache型bridge配置结构体。 |
| mqs_config | MqsConfig object | mqs型bridge配置结构体。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| database_type | String | 数据库类型,支持mariadb, postgresql, mysql。 |
| database_address | String | 数据库地址。 |
| database_name | String | 数据库名。 |
| user_name | String | 用户名。 |
| password | String | 密码。 |
| max_connections | String | 最大连接数。 |
| max_wait | String | 连接等待最大时间 (ms)。 |
| max_active | String | 连接池支持的最大连接数。 |
| initial_size | String | 初始连接数。 |
| min_idle | String | 最小空闲连接数。 |
| remove_abandoned_timeout | String | 连接超时回收时间 (s)。 |
| remove_abandoned | String | 允许超时回收。 |
| enable_ssl | String | 允许SSL。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cache_type | String | cache类型,支持redis_single, redis_cluster |
| client_name | String | Redis Client 名称 |
| address | String | cache地址。 |
| database | String | 数据库编号。 |
| user_name | String | 用户名。 |
| password | String | 密码。 |
| max_connections | String | 最大连接数。 |
| max_wait | String | 连接等待最大时间 (ms)。 |
| max_active | String | 连接池支持的最大连接数。 |
| max_idle | String | 最大空闲连接数。 |
| min_idle | String | 最小空闲连接数。 |
| connection_timeout | String | 连接超时时间(ms)。 |
| socket_timeout | String | Socket超时时间(ms)。 |
| max_attempts | String | 异常重试次数。 |
| enable_ssl | String | 允许SSL。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| mqs_address | String | MQS地址。 |
| mqs_account_config | MqsAccountConfig object | mqs型bridge账号信息结构体。 |
| is_encrypt_transport | String | 允许传输加密。 |
| max_connections | String | 最大连接数。 |
| max_active | String | bridge支持的最大topic数量上限。 |
| topics | String | topic。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| auth_type | String | 账户信息,鉴权方式。 |
| enterprise | String | 企业项目。 |
| project_id | String | 项目id。 |
| account | String | 账号。 |
| account_secret | String | 账号密码。 |
| app_id | String | app id。 |
| app_secret | String | app 密码。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| domain_id | String | 参数解释: 租户账号id。 取值范围: 不涉及。 |
| namespace | String | 参数解释: 租户的project id。 取值范围: 不涉及。 |
| vpc_name | String | 参数解释: 虚拟私有云名称。 取值范围: 不涉及。 |
| vpc_id | String | 参数解释: 虚拟私有云唯一标识。 取值范围: 不涉及。 |
| subnet_name | String | 参数解释: 子网名称。 取值范围: 不涉及。 |
| subnet_id | String | 参数解释: 子网编号。 取值范围: 不涉及。 |
| cidr | String | 参数解释: 子网掩码。 取值范围: 不涉及。 |
| gateway | String | 参数解释: 网关。 取值范围: 不涉及。 |
| security_groups | Array of strings | 参数解释: 安全组 取值范围: 字符串列表 |
| is_safety | Boolean | 参数解释: 是否开启安全访问。开启时,需要您自行配置VPCEP网络但可以提供更安全的VPC连接访问并打通内网域名。注意:开启后无法关闭。 取值范围: |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
请求示例
当前租户bridge列表。
GET https://{Endpoint}/v2/{project_id}/fgs/servicebridge?offset=0&limit=400 响应示例
状态码:200
{
"service_bridges" : [ {
"bridge_name" : "test",
"project_id" : "xxxxx",
"bridge_config" : {
"data_source_type" : "rds"
}
} ],
"next_marker" : 4
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | ok |
| 401 | Unauthorized 鉴权失败。 |
| 403 | Forbidden 没有操作权限。 |
| 404 | Not Found 找不到资源。 |
| 500 | Internal Server Error 服务内部错误。 |
错误码
请参见错误码。