# 查询路由传播列表 - ListPropagations #### 功能介绍 查询路由传播列表。 #### 接口约束 - 支持分页查询, 支持过滤查询：state, resource_type, attachment_id。 - 支持单字段排序，排序字段有\[id,created_at,updated_at\]，不支持多字段排序。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-er/er_02_0008.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-er/er_02_0015.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | er:routeTables:listPropagations | List | routeTables \* | - g:EnterpriseProjectId - g:ResourceTag/\ | er:propagations:list | - | #### URI GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | | er_id | 是 | String | 企业路由器实例ID | | route_table_id | 是 | String | 路由表ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 每页返回的个数。 取值范围：1\~2000。 最小值：**1** 最大值：**2000** | | marker | 否 | String | 查询的页码id，为空时为查询第一页。 使用说明：必须与limit一起使用。 最小长度：**1** 最大长度：**128** | | attachment_id | 否 | Array of strings | 连接ID | | resource_type | 否 | Array of strings | - 参数解释：资源类型 - 取值范围： - vpc：虚拟私有云 - vpn：VPN网关 - vgw：云专线的虚拟网关 - peering：对等连接，通过云连接CC加载不同区域的企业路由器来创建"对等连接（Peering）"连接 - gdgw：全域接入网关 - cfw：云防火墙 | | state | 否 | Array of strings | - 参数解释：资源状态 - 取值范围： - pending：等待中 - available：可用 - modifying：修改中 - deleting：删除中 - deleted：已删除 - failed：失败 - freezed：冻结 | | sort_key | 否 | Array of strings | - 参数解释：按关键字排序，默认按照id排序 - 取值范围: - id：资源标识 - name：资源名称 - state：资源状态 | | sort_dir | 否 | Array of strings | 返回结果按照升序或降序排列，默认为asc,降序为desc | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | propagations | Array of [Propagation] objects | 路由传播列表 数组长度：**0 - 2000** | | request_id | String | 请求ID | | page_info | [PageInfo] object | 分页查询的信息 | 表4Propagation | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 关联唯一标识 | | project_id | String | 项目ID | | er_id | String | 企业路由器id | | route_table_id | String | 路由表唯一标识 | | attachment_id | String | 连接唯一标识 | | resource_type | String | - 参数解释：资源类型 - 取值范围： - vpc：虚拟私有云 - vpn：VPN网关 - vgw：云专线的虚拟网关 - peering：对等连接，通过云连接CC加载不同区域的企业路由器来创建"对等连接（Peering）"连接 - gdgw：全域接入网关 - cfw：云防火墙 | | resource_id | String | 连接的资源唯一标识 | | route_policy | [ImportRoutePolicy] object | 入方向路由策略 | | state | String | - 参数解释：状态 - 取值范围： - pending：等待中 - available：可用 - modifying：修改中 - deleting：删除中 - deleted：已删除 - failed：失败 | | created_at | String | 资源创建时间 采用UTC时间 格式：YYYY-MM-DDTHH:mm:ss.sssZ | | updated_at | String | 资源更新时间 采用UTC时间 格式：YYYY-MM-DDTHH:mm:ss.sssZ | 表5ImportRoutePolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | import_policy_id | String | 入方向Ipv4协议路由策略id 最小长度：**0** 最大长度：**36** | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 下一个marker标识，为空时表示最后一页 | | current_count | Integer | 当前列表中资源数量 | #### 请求示例 查询路由表传播列表 ``` GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/7dec531a-7714-11eb-9439-0242ac130002/route-tables/91c013e2-d65a-474e-9177-c3e1799ca726/propagations ``` #### 响应示例 **状态码：200** OK ``` { "propagations" : [ { "id" : "915a14a6-867b-4af7-83d1-70efceb146f9", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "er_id" : "7dec531a-7714-11eb-9439-0242ac130002", "route_table_id" : "91c013e2-d65a-474e-9177-c3e1799ca726", "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64", "resource_type" : "vpc", "resource_id" : "4e5fe97c-82bc-432e-87d8-06d7e157dffa", "route_policy" : { "import_policy_id" : "" }, "state" : "pending", "created_at" : "2020-03-11T15:13:31.000Z", "updated_at" : "2020-03-11T15:13:31.000Z" } ], "page_info" : { "next_marker" : "1", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.er.v3.region.ErRegion; import com.huaweicloud.sdk.er.v3.*; import com.huaweicloud.sdk.er.v3.model.*; public class ListPropagationsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ErClient client = ErClient.newBuilder() .withCredential(auth) .withRegion(ErRegion.valueOf("")) .build(); ListPropagationsRequest request = new ListPropagationsRequest(); request.withErId("{er_id}"); request.withRouteTableId("{route_table_id}"); try { ListPropagationsResponse response = client.listPropagations(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdker.v3.region.er_region import ErRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdker.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ErClient.new_builder() \ .with_credentials(credentials) \ .with_region(ErRegion.value_of("")) \ .build() try: request = ListPropagationsRequest() request.er_id = "{er_id}" request.route_table_id = "{route_table_id}" response = client.list_propagations(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := er.ErClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := er.NewErClient(hcClient) request := &model.ListPropagationsRequest{} request.ErId = "{er_id}" request.RouteTableId = "{route_table_id}" response, err := client.ListPropagations(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ER/sdk?api=ListPropagations)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-er/ErrorCode.html)。