Querying Route Propagations
Function
This API is used to query route propagations.
Constraints
Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (id, created_at, or updated_at) is supported.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
er_id |
Yes |
String |
Enterprise router ID |
route_table_id |
Yes |
String |
Route table ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 0 to 2000 Minimum: 0 Maximum: 2000 |
marker |
No |
String |
ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 1 Maximum: 128 |
attachment_id |
No |
Array |
Attachment ID |
resource_type |
No |
Array |
Attachment type.
|
state |
No |
Array |
Resource status. Value options: pending, available, modifying, deleting, deleted, failed and freezed |
sort_key |
No |
Array |
Keyword for sorting. The keyword can be id, name, or state. By default, id is used. |
sort_dir |
No |
Array |
Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
propagations |
Array of Propagation objects |
Route propagations Array Length: 0 - 2000 |
request_id |
String |
Request ID |
page_info |
PageInfo object |
Pagination query information |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Unique association ID |
project_id |
String |
Project ID |
er_id |
String |
Enterprise router ID |
route_table_id |
String |
Unique ID of the route table |
attachment_id |
String |
Unique ID of the attachment |
resource_type |
String |
Attachment type.
|
resource_id |
String |
Unique ID of the attachment |
route_policy |
ImportRoutePolicy object |
Route that controls inbound traffic |
state |
String |
Status. Value options: pending, available, modifying, deleting, deleted, and failed |
created_at |
String |
Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
updated_at |
String |
Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
Example Requests
Querying route table propagations
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/7dec531a-7714-11eb-9439-0242ac130002/route-tables/91c013e2-d65a-474e-9177-c3e1799ca726/propagations
Example Responses
Status code: 200
OK
{ "propagations" : [ { "id" : "915a14a6-867b-4af7-83d1-70efceb146f9", "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:31Z", "updated_at" : "2020-03-11T15:13:31Z" } ], "page_info" : { "next_marker" : "1", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" }
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
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.*; import java.util.List; import java.util.ArrayList; 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ErClient client = ErClient.newBuilder() .withCredential(auth) .withRegion(ErRegion.valueOf("<YOUR REGION>")) .build(); ListPropagationsRequest request = new ListPropagationsRequest(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withAttachmentId(); request.withResourceType(); request.withState(); request.withSortKey(); request.withSortDir(); 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = ErClient.new_builder() \ .with_credentials(credentials) \ .with_region(ErRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPropagationsRequest() request.limit = <limit> request.marker = "<marker>" request.attachment_id = request.resource_type = request.state = request.sort_key = request.sort_dir = 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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := er.NewErClient( er.ErClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPropagationsRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest response, err := client.ListPropagations(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot