From 2eea95ac58f46a8110915d6091082fcae0e4ec40 Mon Sep 17 00:00:00 2001 From: fanqinying Date: Tue, 24 Jun 2025 08:13:54 +0000 Subject: [PATCH] ER API 20250126 version Reviewed-by: Sarda, Priya Co-authored-by: fanqinying Co-committed-by: fanqinying --- docs/er/api-ref/ALL_META.TXT.json | 11 +- docs/er/api-ref/APIChangeHistory.html | 40 ++- docs/er/api-ref/AcceptAttachment.html | 201 ++++++----- docs/er/api-ref/AssociateRouteTable.html | 110 +++--- docs/er/api-ref/Association.html | 2 +- docs/er/api-ref/Attachments.html | 2 +- docs/er/api-ref/AvailableZone.html | 2 +- docs/er/api-ref/CLASS.TXT.json | 8 +- docs/er/api-ref/CreateEnterpriseRouter.html | 256 ++++++++------ docs/er/api-ref/CreateFlowLog.html | 134 ++++---- docs/er/api-ref/CreateResourceTag.html | 22 +- docs/er/api-ref/CreateRouteTable.html | 158 +++++---- docs/er/api-ref/CreateStaticRoute.html | 266 ++++++++------- docs/er/api-ref/CreateVpcAttachment.html | 216 ++++++++---- docs/er/api-ref/DeleteEnterpriseRouter.html | 4 +- docs/er/api-ref/DeleteFlowLog.html | 4 +- docs/er/api-ref/DeleteResourceTag.html | 7 +- docs/er/api-ref/DeleteRouteTable.html | 4 +- docs/er/api-ref/DeleteStaticRoute.html | 4 +- docs/er/api-ref/DeleteVpcAttachment.html | 4 +- docs/er/api-ref/DisableFlowLog.html | 114 +++---- docs/er/api-ref/DisablePropagation.html | 4 +- docs/er/api-ref/DisassociateRouteTable.html | 6 +- docs/er/api-ref/EnableFlowLog.html | 114 +++---- docs/er/api-ref/EnablePropagation.html | 120 +++---- docs/er/api-ref/EnterpriseRouterInstance.html | 2 +- docs/er/api-ref/FlowLog.html | 2 +- docs/er/api-ref/ListAssociations.html | 128 +++---- docs/er/api-ref/ListAttachments.html | 323 ++++++++++-------- docs/er/api-ref/ListAvailabilityZone.html | 46 +-- docs/er/api-ref/ListEffectiveRoutes.html | 148 ++++---- docs/er/api-ref/ListEnterpriseRouters.html | 255 +++++++++----- docs/er/api-ref/ListFlowLogs.html | 148 ++++---- docs/er/api-ref/ListProjectTags.html | 33 +- docs/er/api-ref/ListPropagations.html | 142 ++++---- docs/er/api-ref/ListRouteTables.html | 155 +++++---- docs/er/api-ref/ListStaticRoutes.html | 282 ++++++++------- docs/er/api-ref/ListVpcAttachments.html | 209 ++++++++---- docs/er/api-ref/Propagation.html | 2 +- docs/er/api-ref/QuotaManager.html | 2 +- docs/er/api-ref/RejectAttachment.html | 201 ++++++----- docs/er/api-ref/Route.html | 2 +- docs/er/api-ref/RouteTable.html | 2 +- docs/er/api-ref/ShowAttachment.html | 135 ++++---- docs/er/api-ref/ShowEnterpriseRouter.html | 217 +++++++----- docs/er/api-ref/ShowFlowLog.html | 114 +++---- docs/er/api-ref/ShowQuotas.html | 135 ++++++-- docs/er/api-ref/ShowResourceTag.html | 51 ++- docs/er/api-ref/ShowRouteTable.html | 131 +++---- docs/er/api-ref/ShowStaticRoute.html | 186 +++++----- docs/er/api-ref/ShowVpcAttachment.html | 187 ++++++---- docs/er/api-ref/Tags.html | 2 +- docs/er/api-ref/UpdateAttachment.html | 135 ++++---- docs/er/api-ref/UpdateEnterpriseRouter.html | 217 +++++++----- docs/er/api-ref/UpdateFlowLog.html | 114 +++---- docs/er/api-ref/UpdateRouteTable.html | 172 ++++------ docs/er/api-ref/UpdateStaticRoute.html | 230 +++++++------ docs/er/api-ref/UpdateVpcAttachment.html | 187 ++++++---- docs/er/api-ref/VPCAttachment.html | 2 +- docs/er/api-ref/er_02_0001.html | 11 + docs/er/api-ref/er_02_0018.html | 2 +- docs/er/api-ref/er_02_0033.html | 2 +- docs/er/api-ref/er_02_0034.html | 2 +- 63 files changed, 3515 insertions(+), 2612 deletions(-) diff --git a/docs/er/api-ref/ALL_META.TXT.json b/docs/er/api-ref/ALL_META.TXT.json index bdd8bd862..dd0ae393b 100644 --- a/docs/er/api-ref/ALL_META.TXT.json +++ b/docs/er/api-ref/ALL_META.TXT.json @@ -145,7 +145,7 @@ "node_id":"deleteenterpriserouter.xml", "product_code":"er", "code":"8", - "des":"This API is used to delete an enterprise router.DELETE /v3/{project_id}/enterprise-router/instances/{er_id}NoneNoneDeleting an enterprise routerNoneSee Error Codes.", + "des":"This API is used to delete an enterprise router.DELETE /v3/{project_id}/enterprise-router/instances/{er_id}NoneStatus code: 202AcceptedNoneDeleting an enterprise routerNo", "doc_type":"api", "kw":"Deleting an Enterprise Router,Enterprise Routers,API Reference", "search_title":"", @@ -505,7 +505,7 @@ "node_id":"deleteroutetable.xml", "product_code":"er", "code":"26", - "des":"This API is used to delete a route table.DELETE /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}NoneNoneNoneSee Error Codes.", + "des":"This API is used to delete a route table.DELETE /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}NoneStatus code: 202AcceptedNoneNoneSee Error Code", "doc_type":"api", "kw":"Deleting a Route Table,Route Tables,API Reference", "search_title":"", @@ -765,7 +765,7 @@ "node_id":"liststaticroutes.xml", "product_code":"er", "code":"39", - "des":"This API is used to query static routes.Pagination query is supported. The supported query criteria are destination, attachment_id, resource_type, and type.Only sorting b", + "des":"This API is used to query static routes.Pagination query is supported. The supported query criteria are destination, attachment_id, resource_type, and type.Pagination que", "doc_type":"api", "kw":"Querying Static Routes,Routes,API Reference", "search_title":"", @@ -805,7 +805,7 @@ "node_id":"deletestaticroute.xml", "product_code":"er", "code":"41", - "des":"This API is used to delete a static route.DELETE /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}NoneNoneNoneSee Error Codes.", + "des":"This API is used to delete a static route.DELETE /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}NoneStatus code: 202AcceptedNone", "doc_type":"api", "kw":"Deleting a Static Route,Routes,API Reference", "search_title":"", @@ -1457,7 +1457,8 @@ "metedata":[ { "documenttype":"api", - "prodname":"er" + "prodname":"er", + "opensource":"true" } ], "title":"Error Codes", diff --git a/docs/er/api-ref/APIChangeHistory.html b/docs/er/api-ref/APIChangeHistory.html index c87d4c057..9a34507b0 100644 --- a/docs/er/api-ref/APIChangeHistory.html +++ b/docs/er/api-ref/APIChangeHistory.html @@ -8,10 +8,46 @@ -

2024-11-01

+

2025-06-23

+ +

This release incorporates the following changes:

+
  • Modified the description of parameter state in sections Creating an Enterprise Router, Updating an Enterprise Router, Querying Details About an Enterprise Router, and Querying Enterprise Routers.
  • Added ipv6_enable to the response example in sections Creating a VPC Attachment, Updating a VPC Attachment, and Querying Details About a VPC Attachment.
  • Modified the description of the resource_type parameter in sections Accepting a Shared Attachment and Rejecting a Shared Attachment and retained only VPC.
  • Added bgp_options to the request parameter in section Creating a Route Table.
  • Modified the description of the route_policy parameter in sections Creating a Route Association, Querying Route Associations, and Deleting a Route Association.
  • Added the route_policy parameter to sections Creating a Route Propagation, Querying Route Propagations, and Deleting a Route Propagation.
  • Added the priority parameter to the response parameters and examples in sections Creating a Static Route and Querying Effective Routes.
  • Modified the description of the response parameter tags in sections Querying Attachments, Accepting a Shared Attachment, and Rejecting a Shared Attachment.
+ + +

2025-06-06

+ +

This release incorporates the following changes:

+
  • Added ipv6_enable to the response parameters and response examples in Creating a VPC Attachment, Updating a VPC Attachment, and Querying Details About a VPC Attachment.
  • Added priority to the response parameters and response examples in Creating a Static Route, Updating a Static Route, Querying Details About a Static Route, Querying Static Routes and Querying Effective Routes.
+ + +

2025-05-16

+ +

This release incorporates the following changes:

+
  • Modified the request and response examples in sections "Accepting a Shared Attachment", "Rejecting a Shared Attachment", "Querying Route Tables", "Creating an Enterprise Router", and "Querying Flow Logs".
  • Modified the description of the type parameter and added description about the multicast_domain and multicast_domain_association parameters in section "Querying Quotas".
+ + +

2025-03-18

+ +

This release incorporates the following changes:

+
  • Kept only the content about VPC attachments in sections "Accepting a Shared Attachment" and "Rejecting a Shared Attachment".
  • Kept only the content about VPC attachments in APIs about Routes.
  • Changed the link to the Log Tank Service User Guide in section "Creating a Flow Log".
+ + +

2025-03-12

+ +

This release incorporates the following changes:

+

Deleted unsupported parameters from section "Querying Enterprise Routers".

+ + +

2025-01-23

+ +

This release incorporates the following changes:

+
  • Modified the description of resource_type and added the description of CFW in "Other Types of Attachments", "Associations", "Propagations", "Routes", and "Tags".
  • Added the description that the VPN supports flow logs in "Creating a Flow Log".
+ + +

2024-11-01

This release incorporates the following changes:

-
  • Modified the parameters in Example Responses in "Accepting a Shared Attachment" and "Rejecting a Shared Attachment".
  • Added the permissions of the APIs for accepting a shared connection and rejecting a shared connection in "Other Types of Attachments".
+
  • Modified the parameters in Example Responses in "Accepting a Shared Attachment" and "Rejecting a Shared Attachment".
  • Added the permissions of the APIs for accepting a shared attachment and rejecting a shared attachment in "Other Types of Attachments".

2024-09-20

diff --git a/docs/er/api-ref/AcceptAttachment.html b/docs/er/api-ref/AcceptAttachment.html index 10023148f..e008a4b62 100644 --- a/docs/er/api-ref/AcceptAttachment.html +++ b/docs/er/api-ref/AcceptAttachment.html @@ -1,240 +1,257 @@

Accepting a Shared Attachment

-

Function

This API is used to accept a shared attachment.

+

Function

This API is used to accept a shared attachment.

-

URI

POST /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}/accept

+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}/accept

-
Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

er_id

+

er_id

Yes

+

Yes

String

+

String

Enterprise router ID

+

Enterprise router ID

attachment_id

+

attachment_id

Yes

+

Yes

String

+

String

Attachment ID

+

Attachment ID

-

Request Parameters

None

+

Request Parameters

None

-

Response Parameters

Status code: 202

+

Response Parameters

Status code: 202

-
Table 2 Response body parameters

Parameter

+
- - - - - - - -
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

attachment

+

attachment

AttachmentResponse object

+

AttachmentResponse object

Attachment basic information

+

Attachment basic information

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 3 AttachmentResponse

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
Table 3 AttachmentResponse

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Attachment name

+

Attachment name

id

+

id

String

+

String

Attachment ID

+

Attachment ID

description

+

description

String

+

String

Supplementary information

+

Supplementary information

state

+

state

String

+

String

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request

+

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, initiating_request, freezed, or invalid.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Attachment tags

+

Attachment tags.

project_id

+

project_id

String

+

String

Project ID

+

Project ID

resource_id

+

resource_id

String

+

String

Attached resource ID on its own service console

+

Attached resource ID on its own service console

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment
+

Attachment type.

+
  • vpc: VPC

    +

resource_project_id

+

resource_project_id

String

+

String

ID of the project that the resource belongs to

+

ID of the project that the resource belongs to

+

ipv6_enable

+

Boolean

+

Whether to enable IPv6. The value false indicates that IPv6 is disabled, and the value true indicates that IPv6 is enabled. This parameter is not supported.

-
Table 4 Tag

Parameter

+
- - - - - - - -
Table 4 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

-

Minimum: 1

-

Maximum: 128

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +
+

Minimum: 1

+

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

-

Minimum: 0

-

Maximum: 128

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +
+

Minimum: 0

+

Maximum: 255

-

Example Requests

Accepting a shared attachment

-
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/attachments/6f83b848-8331-4271-ac0c-ef94b7686401/accept
+

Example Requests

Accepting a shared attachment

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/attachments/6f83b848-8331-4271-ac0c-ef94b7686401/accept
-

Example Responses

Status code: 202

-

Accepted

-
{
+

Example Responses

Status code: 202

+

Accepted

+
{
   "attachment" : {
     "id" : "6f83b848-8331-4271-ac0c-ef94b7686402,",
     "name" : "vpc attachment,",
     "description" : "VPC attachment",
-    "state" : "avaliable",
+    "state" : "available",
     "created_at" : "2020-03-11T15:13:31Z",
     "updated_at" : "2020-03-11T15:13:31Z",
     "tags" : [ ],
     "project_id" : "0605767a9980d5762fbcc00b3537e757",
     "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
     "resource_type" : "vpc",
-    "resource_project_id" : null
+    "resource_project_id" : "0605767a9980d5762fbcc00b3537e751"
   },
   "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
 }
-

Status Codes

-
- @@ -132,146 +132,146 @@

Response Parameters

Status code: 202

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

202

+

202

Accepted

+

Accepted

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/er/api-ref/AssociateRouteTable.html b/docs/er/api-ref/AssociateRouteTable.html index 51bc93a66..d711b203d 100644 --- a/docs/er/api-ref/AssociateRouteTable.html +++ b/docs/er/api-ref/AssociateRouteTable.html @@ -98,7 +98,7 @@

ExportRoutePolicy object

Route that controls outbound traffic. Note that this is not currently supported. This parameter is not supported for now.

+

Route that controls outbound traffic. This parameter is not supported for now.

Table 5 Response header parameters

Parameter

+
- - - - -
Table 5 Response header parameters

Parameter

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

String

+

String

Idempotence identifier

+

Idempotence identifier

-
Table 6 Response body parameters

Parameter

+
- - - - - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

association

+

association

Association object

+

Association object

Association details

+

Association details

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 7 Association

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 Association

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Unique association ID

+

Unique association ID

Maximum: 36

route_table_id

+

route_table_id

String

+

String

Unique ID of the route table

+

Unique ID of the route table

Maximum: 36

attachment_id

+

attachment_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

Maximum: 36

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

resource_id

+

resource_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

state

+

state

String

+

String

Status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Status. Value options: pending, available, modifying, deleting, deleted, and failed

created_at

+

created_at

String

+

String

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

updated_at

+

updated_at

String

+

String

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

route_policy

+

route_policy

ExportRoutePolicy object

+

ExportRoutePolicy object

Route that controls outbound traffic. Note that this is not currently supported. This parameter is not supported for now.

+

Route that controls outbound traffic. This parameter is not supported for now.

-
- @@ -232,9 +225,13 @@ - @@ -243,214 +240,279 @@

Response Parameters

Status code: 202

-
Table 8 ExportRoutePolicy

Parameter

+
- - - - - diff --git a/docs/er/api-ref/Association.html b/docs/er/api-ref/Association.html index 6130c3adc..8a611cd3e 100644 --- a/docs/er/api-ref/Association.html +++ b/docs/er/api-ref/Association.html @@ -1,7 +1,7 @@

Associations

-

+

- - - - -
Table 8 ExportRoutePolicy

Parameter

Type

+

Type

Description

+

Description

export_policy_id

+

export_policy_id

String

+

String

ID of the route policy that controls outbound traffic. This parameter is not supported for now.

+

ID of the route policy that controls outbound traffic. This parameter is not supported for now.

Minimum: 0

Maximum: 36

cidr_blocks

-

No

-

Array of strings

-

Enterprise router CIDR block. This parameter is not supported for now.

-

Minimum: 1

-

Maximum: 64

-

Array Length: 0 - 100

-
@@ -221,7 +209,12 @@

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

Table 6 Response header parameters

Parameter

+
- - - - -
Table 6 Response header parameters

Parameter

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

String

+

String

Idempotence identifier

+

Idempotence identifier

-
Table 7 Response body parameters

Parameter

+
- - - - - - - -
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description

instance

+

instance

EnterpriseRouter object

+

EnterpriseRouter object

Enterprise router

+

Enterprise router

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 8 EnterpriseRouter

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
Table 8 EnterpriseRouter

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Enterprise router ID

+

Enterprise router ID

name

+

name

String

+

String

Enterprise router name

+

Enterprise router name

description

+

description

String

+

String

Supplementary information about an enterprise router

+

Supplementary information about an enterprise router

state

+

state

String

+

String

Enterprise router status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Resource status. The value can be pending, available, modifying, deleting, deleted, failed, or freezed.

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Tag information

+

Tag information

charge_mode

+

charge_mode

String

+

String

Billing mode (pay-per-use)

+

Billing mode (pay-per-use)

Default: postPaid

created_at

+

instance_type

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Instance type. This parameter is not supported.

updated_at

+

created_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

enterprise_project_id

+

updated_at

String

+

String

Enterprise project ID

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

project_id

+

enterprise_project_id

String

+

String

Project ID

+

Enterprise project ID

asn

+

project_id

Long

+

String

Enterprise router BGP ASN

+

Project ID

enable_default_propagation

+

asn

Boolean

+

Long

Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled.

+

Enterprise router BGP ASN

enable_default_association

+

support_multicast

Boolean

+

Boolean

Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled.

+

Whether an enterprise router supports multicast. The default value is false, indicating that multicast is disabled. This parameter is not supported.

default_propagation_route_table_id

+

enable_default_propagation

String

+

Boolean

Default propagation route table ID

+

Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled.

default_association_route_table_id

+

enable_default_association

String

+

Boolean

Default association route table ID

+

Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled.

availability_zone_ids

+

default_propagation_route_table_id

Array of strings

+

String

AZs where the enterprise router is located

+

Default propagation route table ID

auto_accept_shared_attachments

+

default_association_route_table_id

Boolean

+

String

Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled.

+

Default association route table ID

cidr_blocks

+

availability_zone_ids

Array of strings

+

Array of strings

Enterprise router CIDR block. This parameter is not supported for now.

+

AZs where the enterprise router is located

+

auto_accept_shared_attachments

+

Boolean

+

Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled.

+

cidr_blocks

+

Array of strings

+

CIDR block of an enterprise router. This parameter is not supported.

+

bandwidth

+

Bandwidth object

+

Bandwidth request body. This parameter is not supported.

+

billing_info

+

String

+

Order information. This parameter is not supported.

+

frozen_scene

+

String

+

Frozen reason. The reason can be account arrears, public security, and violations of laws and regulations. This parameter is not supported.

-
Table 9 Tag

Parameter

+
- - - - - - - - + + +
Table 9 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

+
+
+ +
+ + + + + + + diff --git a/docs/er/api-ref/CreateFlowLog.html b/docs/er/api-ref/CreateFlowLog.html index a889b0524..ba0af01e2 100644 --- a/docs/er/api-ref/CreateFlowLog.html +++ b/docs/er/api-ref/CreateFlowLog.html @@ -125,8 +125,9 @@ @@ -164,7 +165,8 @@
Table 10 Bandwidth

Parameter

+

Type

+

Description

+

size

+

Integer

+

Bandwidth, in Mbit/s. The default value is 0, indicating that the bandwidth is not limited. The value -1 indicates that the bandwidth is limited to 2 kbit/s. This parameter is not supported.

+

Minimum: -1

+

Default: 0

String

Type of resource whose flow logs are collected.

-
  • VPC attachments

    -
  • Virtual gateway attachments

    +
    • VPC attachment

      +
    • Virtual gateway attachment

      +
    • VPN gateway attachment

String

Flow log storage type.

-

LTS: Logs are stored on LTS servers.

+
  • LTS: Logs are stored on LTS servers.

    +

log_store_name

@@ -184,162 +186,162 @@

Response Parameters

Status code: 202

-
Table 5 Response header parameters

Parameter

+
- - - - -
Table 5 Response header parameters

Parameter

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

String

+

String

Idempotence identifier

+

Idempotence identifier

-
Table 6 Response body parameters

Parameter

+
- - - - - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

flow_log

+

flow_log

FlowLog object

+

FlowLog object

Flow log details

+

Flow log details

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
- @@ -199,9 +204,13 @@ - @@ -210,184 +219,193 @@

Response Parameters

Status code: 202

-
Table 7 FlowLog

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/er/api-ref/CreateResourceTag.html b/docs/er/api-ref/CreateResourceTag.html index 2e0a49337..f18b07bcc 100644 --- a/docs/er/api-ref/CreateResourceTag.html +++ b/docs/er/api-ref/CreateResourceTag.html @@ -44,12 +44,13 @@ - @@ -97,7 +98,12 @@ - @@ -108,16 +114,22 @@ -
Table 7 FlowLog

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Flow log ID

+

Flow log ID

name

+

name

String

+

String

Flow log name

+

Flow log name

description

+

description

String

+

String

Flow log description

+

Flow log description

project_id

+

project_id

String

+

String

Project ID of the flow log task creator

+

Project ID of the flow log task creator

resource_type

+

resource_type

String

+

String

Resource type. The value is attachment.

+

Resource type. The value is attachment.

resource_id

+

resource_id

String

+

String

Resource ID

+

Resource ID

log_group_id

+

log_group_id

String

+

String

Log group ID

+

Log group ID

log_stream_id

+

log_stream_id

String

+

String

Log stream ID

+

Log stream ID

log_store_type

+

log_store_type

String

+

String

Flow log storage type. LTS is used for log storage.

+

Flow log storage type. LTS is used for log storage.

log_store_name

+

log_store_name

String

+

String

Flow log storage name. This parameter is not supported for now.

+

Flow log storage name. This parameter is not supported for now.

log_aggregation_interval

+

log_aggregation_interval

Integer

+

Integer

Log aggregation time, in seconds. The value ranges from 60 to 600.

+

Log aggregation time, in seconds. The value ranges from 60 to 600.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

state

+

state

String

+

String

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

enabled

+

enabled

Boolean

+

Boolean

Whether to enable flow logs. The value can be true or false.

+

Whether to enable flow logs. The value can be true or false.

String

Resource type.

+

Tagged resource type.

  • instance: enterprise router

  • route-table: route table

  • vpc-attachment: VPC attachment

  • vgw-attachment: virtual gateway attachment

  • vpn-attachment: VPN gateway attachment

    +
  • cfw-attachment: CFW instance attachment

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

-

Response Parameters

None

+

Response Parameters

Status code: 204

+

No Content

+

None

Example Requests

Creating tags for a resource

POST https://{erouter-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags
diff --git a/docs/er/api-ref/CreateRouteTable.html b/docs/er/api-ref/CreateRouteTable.html
index 50c6e1a0f..53b2ea134 100644
--- a/docs/er/api-ref/CreateRouteTable.html
+++ b/docs/er/api-ref/CreateRouteTable.html
@@ -188,7 +188,12 @@
 
 

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

Table 7 Response header parameters

Parameter

+
- - - - -
Table 7 Response header parameters

Parameter

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

String

+

String

Idempotence identifier

+

Idempotence identifier

-
Table 8 Response body parameters

Parameter

+
- - - - - - - -
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

route_table

+

route_table

RouteTable object

+

RouteTable object

Route table

+

Route table

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 9 RouteTable

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 9 RouteTable

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Route table ID

+

Route table ID

name

+

name

String

+

String

Route table name

+

Route table name

description

+

description

String

+

String

Supplementary information

+

Supplementary information

is_default_association

+

is_default_association

Boolean

+

Boolean

Whether the route table is the default association route table.

+

Whether the route table is the default association route table.

Default: false

is_default_propagation

+

is_default_propagation

Boolean

+

Boolean

Whether the route table is the default propagation route table.

+

Whether the route table is the default propagation route table.

state

+

state

String

+

String

Route table status. The value can be pending, available, deleting, deleted, or failed.

+

Route table status. The value can be pending, available, deleting, deleted, or failed.

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Tag

+

Tag

bgp_options

+

bgp_options

BgpOptions object

+

BgpOptions object

BGP route selection parameters. This parameter is not supported for now.

+

BGP route selection parameters. This parameter is not supported for now.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

-
Table 10 Tag

Parameter

+
- - - - - - - -
Table 10 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

-
Table 11 BgpOptions

Parameter

+
- - - - - - - - diff --git a/docs/er/api-ref/CreateStaticRoute.html b/docs/er/api-ref/CreateStaticRoute.html index 19a8b0ab2..112be31c1 100644 --- a/docs/er/api-ref/CreateStaticRoute.html +++ b/docs/er/api-ref/CreateStaticRoute.html @@ -1,294 +1,312 @@

Creating a Static Route

-

Function

This API is used to create a static route. Static routes are manually created, and effective routes are preferred routes.

+

Function

This API is used to create a static route. Static routes are manually created, and effective routes are preferred routes.

-

Constraints

If is_blackhole is set to false, the attachment_id parameter must be carried. If is_blackhole is set to true, the attachment_id parameter cannot be passed.

+

Constraints

If is_blackhole is set to false, the attachment_id parameter must be carried. If is_blackhole is set to true, the attachment_id parameter cannot be passed.

-

URI

POST /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes

+

URI

POST /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes

-
Table 11 BgpOptions

Parameter

Type

+

Type

Description

+

Description

load_balancing_as_path_ignore

+

load_balancing_as_path_ignore

Boolean

+

Boolean

BGP option to specify that AS-Path attributes are not compared during load balancing. This parameter is not supported for now.

+

BGP option to specify that AS-Path attributes are not compared during load balancing. This parameter is not supported for now.

load_balancing_as_path_relax

+

load_balancing_as_path_relax

Boolean

+

Boolean

BGP option to specify that AS-Path attributes with the same length are not compared during load balancing. This parameter is not supported for now.

+

BGP option to specify that AS-Path attributes with the same length are not compared during load balancing. This parameter is not supported for now.

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

route_table_id

+

route_table_id

Yes

+

Yes

String

+

String

Route table ID

+

Route table ID

-

Request Parameters

-
Table 2 Request header parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

No

+

No

String

+

String

Idempotence identifier

-

Minimum: 1

-

Maximum: 64

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

-
Table 3 Request body parameters

Parameter

+
- - - - - - -
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

route

+

route

Yes

+

Yes

CreateRoute object

+

CreateRoute object

Request body for creating a route

+

Request body for creating a route

-
Table 4 CreateRoute

Parameter

+
- - - - - - - - - - - - - - -
Table 4 CreateRoute

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

destination

+

destination

Yes

+

Yes

String

+

String

Destination address of the route

-

Minimum: 0

-

Maximum: 256

+

Destination address of the route

+

Minimum: 0

+

Maximum: 256

attachment_id

+

attachment_id

No

+

No

String

+

String

ID of the attachment that the next hop of the route points to

+

ID of the attachment that the next hop of the route points to

is_blackhole

+

is_blackhole

No

+

No

Boolean

+

Boolean

Whether the route is a blackhole route. The default value is false.

+

Whether the route is a blackhole route. The default value is false.

-

Response Parameters

Status code: 202

+

Response Parameters

Status code: 202

-
Table 5 Response header parameters

Parameter

+
- - - - -
Table 5 Response header parameters

Parameter

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

String

+

String

Idempotence identifier

+

Idempotence identifier

-
Table 6 Response body parameters

Parameter

+
- - - - - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

route

+

route

Route object

+

Route object

Route

+

Route

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 7 Route

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
Table 7 Route

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Route ID

+

Route ID

type

+

type

String

+

String

Route type. The value is static.

+

Route type. The value is static.

state

+

state

String

+

String

Route status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Route status. Value options: pending, available, modifying, deleting, deleted, and failed

is_blackhole

+

is_blackhole

Boolean

+

Boolean

Whether the route is a blackhole route

+

Whether the route is a blackhole route

destination

+

destination

String

+

String

Destination address of the route

+

Destination address of the route

attachments

+

attachments

Array of RouteAttachment objects

+

Array of RouteAttachment objects

Next hops

+

Next hops

route_table_id

+

route_table_id

String

+

String

Route table ID

+

Route table ID

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

description

+

String

+

Route description.

-
Table 8 RouteAttachment

Parameter

+
- - - - - - - - - - - + + + +
Table 8 RouteAttachment

Parameter

Type

+

Type

Description

+

Description

resource_id

+

resource_id

String

+

String

Attached resource ID

+

Attached resource ID

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment
+

Attachment type.

+
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

    +

attachment_id

+

attachment_id

String

+

String

Attachment ID

+

Attachment ID

+

priority

+

Integer

+

Route priority, the common route is 1

-

Example Requests

Creating a static route

-
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/0d1748a0-5188-11e5-b86f-a51b5f125b84/static-routes
+

Example Requests

Creating a static route

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/0d1748a0-5188-11e5-b86f-a51b5f125b84/static-routes
 
 {
   "route" : {
@@ -298,17 +316,19 @@
   }
 }
-

Example Responses

Status code: 202

-

Accepted

-
{
+

Example Responses

Status code: 202

+

Accepted

+
{
   "route" : {
     "id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
     "type" : "static",
     "destination" : "192.168.0.0/16",
+    "description" : "static route",
     "attachments" : [ {
       "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
       "resource_type" : "vpc",
-      "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
+      "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
+      "priority" : 0
     } ],
     "route_table_id" : "0d1748a0-5188-11e5-b86f-a51b5f125b84",
     "is_blackhole" : false,
@@ -319,23 +339,23 @@
   "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
 }
-

Status Codes

-
- @@ -185,7 +185,12 @@ - @@ -196,9 +201,13 @@ - @@ -207,180 +216,243 @@

Response Parameters

Status code: 202

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

202

+

202

Accepted

+

Accepted

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/er/api-ref/CreateVpcAttachment.html b/docs/er/api-ref/CreateVpcAttachment.html index f02e5cbea..a5cea821d 100644 --- a/docs/er/api-ref/CreateVpcAttachment.html +++ b/docs/er/api-ref/CreateVpcAttachment.html @@ -152,7 +152,7 @@

Boolean

The default value is false. If the value is true, IPv6 is enabled for the VPC attachment. This parameter is not supported for now.

+

The default value is false. If the value is set to true, IPv6 is enabled. This parameter is not supported.

Default: false

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

Table 6 Response header parameters

Parameter

+
- - - - -
Table 6 Response header parameters

Parameter

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

String

+

String

Idempotence identifier

+

Idempotence identifier

-
Table 7 Response body parameters

Parameter

+
- - - - - - - -
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description

vpc_attachment

+

vpc_attachment

VpcAttachmentDetails object

+

VpcAttachmentDetails object

VPC attachment

+

VPC attachment

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 8 VpcAttachmentDetails

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
Table 8 VpcAttachmentDetails

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

VPC attachment ID

+

VPC attachment ID

name

+

name

String

+

String

VPC attachment name

+

VPC attachment name

vpc_id

+

vpc_id

String

+

String

VPC id

+

VPC id

virsubnet_id

+

virsubnet_id

String

+

String

VPC subnet ID

+

VPC subnet ID

auto_create_vpc_routes

+

auto_create_vpc_routes

Boolean

+

Boolean

The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC.

+

The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC.

Default: false

state

+

state

String

+

String

VPC attachment status. Value options: pending, available, modifying, deleting, deleted, failed, initiating_request, rejected, and pending_acceptance

+

VPC attachment status. The value can be pending, available, modifying, deleting, deleted, failed, initiating_request, rejected, pending_acceptance, freezed, or invalid.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Tag information

+

Tag information

description

+

description

String

+

String

Supplementary information about the VPC attachment

+

Supplementary information about the VPC attachment

project_id

+

project_id

String

+

String

Project ID

+

Project ID

vpc_project_id

+

vpc_project_id

String

+

String

ID of the project that the VPC belongs to

+

ID of the project that the VPC belongs to

ipv6_enable

+

ipv6_enable

Boolean

+

Boolean

The default value is false. If the value is true, IPv6 is enabled for the VPC attachment. This parameter is not supported for now.

+

The default value is false. If the value is true, IPv6 is enabled for the VPC attachment. This parameter is not supported for now.

Default: false

route_synchronization

+

RouteSynchronization object

+

Route synchronization configuration. This parameter is not supported.

+

frozen_scene

+

String

+

Frozen reason. The reason can be account arrears, public security, and violations of laws and regulations. This parameter is not supported.

+
-
Table 9 Tag

Parameter

+
- - - - - - - - + + +
Table 9 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

+
+
+ +
+ + + + + + + + + + + + + + + + + + + @@ -407,7 +479,7 @@ "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "project_id" : "08d5a9564a704afda6039ae2babbef3c", - "ipv6_enable" : false, + "ipv6_enable" : "false,", "state" : "pending", "auto_create_vpc_routes" : false, "created_at" : "2020-03-11T15:13:31Z", diff --git a/docs/er/api-ref/DeleteEnterpriseRouter.html b/docs/er/api-ref/DeleteEnterpriseRouter.html index 7d4e64573..4523d1ea1 100644 --- a/docs/er/api-ref/DeleteEnterpriseRouter.html +++ b/docs/er/api-ref/DeleteEnterpriseRouter.html @@ -39,7 +39,9 @@

Request Parameters

None

-

Response Parameters

None

+

Response Parameters

Status code: 202

+

Accepted

+

None

Example Requests

Deleting an enterprise router

DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/94c2b814-99dc-939a-e811-ae84c61ea3ff
diff --git a/docs/er/api-ref/DeleteFlowLog.html b/docs/er/api-ref/DeleteFlowLog.html index 786fd2b56..082bfce51 100644 --- a/docs/er/api-ref/DeleteFlowLog.html +++ b/docs/er/api-ref/DeleteFlowLog.html @@ -50,7 +50,9 @@

Request Parameters

None

-

Response Parameters

None

+

Response Parameters

Status code: 202

+

Accepted

+

None

Example Requests

Deleting a flow log

DELETE https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/flow_logs/b216bc1d-5963-41a7-89f9-779a5128c5ac
diff --git a/docs/er/api-ref/DeleteResourceTag.html b/docs/er/api-ref/DeleteResourceTag.html index 834ad38b4..01f3ea3f8 100644 --- a/docs/er/api-ref/DeleteResourceTag.html +++ b/docs/er/api-ref/DeleteResourceTag.html @@ -50,12 +50,13 @@
- @@ -65,7 +66,9 @@

Request Parameters

None

-

Response Parameters

None

+

Response Parameters

Status code: 204

+

No Content

+

None

Example Requests

DELETE https://{erouter-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/key1
diff --git a/docs/er/api-ref/DeleteRouteTable.html b/docs/er/api-ref/DeleteRouteTable.html index 99330ac6e..2b24ed47c 100644 --- a/docs/er/api-ref/DeleteRouteTable.html +++ b/docs/er/api-ref/DeleteRouteTable.html @@ -48,7 +48,9 @@

Request Parameters

None

-

Response Parameters

None

+

Response Parameters

Status code: 202

+

Accepted

+

None

Example Requests

DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231056/route-tables/4ab54142-7c92-48ad-8288-77727a231052
diff --git a/docs/er/api-ref/DeleteStaticRoute.html b/docs/er/api-ref/DeleteStaticRoute.html index 23897dcf8..0ee82d0e2 100644 --- a/docs/er/api-ref/DeleteStaticRoute.html +++ b/docs/er/api-ref/DeleteStaticRoute.html @@ -48,7 +48,9 @@

Request Parameters

None

-

Response Parameters

None

+

Response Parameters

Status code: 202

+

Accepted

+

None

Example Requests

DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/3ddb4dc2-174e-4d43-9328-b805d5c0c774/static-routes/19d334b7-78c1-4e0e-ba29-b797e641e23c
diff --git a/docs/er/api-ref/DeleteVpcAttachment.html b/docs/er/api-ref/DeleteVpcAttachment.html index 123f2abde..cbee0ae2a 100644 --- a/docs/er/api-ref/DeleteVpcAttachment.html +++ b/docs/er/api-ref/DeleteVpcAttachment.html @@ -50,7 +50,9 @@

Request Parameters

None

-

Response Parameters

None

+

Response Parameters

Status code: 202

+

Accepted

+

None

Example Requests

Deleting a VPC attachment

DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ba931b6-5273-4ed9-8eeb-484d16a4786f/vpc-attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8
diff --git a/docs/er/api-ref/DisableFlowLog.html b/docs/er/api-ref/DisableFlowLog.html index e4ede1aac..3dbdf5116 100644 --- a/docs/er/api-ref/DisableFlowLog.html +++ b/docs/er/api-ref/DisableFlowLog.html @@ -50,143 +50,143 @@

Response Parameters

Status code: 202

-
Table 10 RouteSynchronization

Parameter

+

Type

+

Description

+

route_synchronization_enable

+

Boolean

+

Whether to enable route synchronization.

+

vpc_route_table_type

+

String

+

VPC route table where routes are to be synchronized.

+

route_type

+

String

+

Type of the route to be synchronized.

+

conflict_policy

+

String

+

A conflict policy that specifies whether to synchronize routes with the same destination and next hop to the VPC route table.

String

Resource type.

+

Tagged resource type.

  • instance: enterprise router

  • route-table: route table

  • vpc-attachment: VPC attachment

  • vgw-attachment: virtual gateway attachment

  • vpn-attachment: VPN gateway attachment

    +
  • cfw-attachment: CFW instance attachment

Table 2 Response body parameters

Parameter

+
- - - - - - - -
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

flow_log

+

flow_log

FlowLog object

+

FlowLog object

Flow log details

+

Flow log details

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
- @@ -105,7 +105,9 @@
Table 3 FlowLog

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/er/api-ref/DisablePropagation.html b/docs/er/api-ref/DisablePropagation.html index 011701d5e..1f26c88f8 100644 --- a/docs/er/api-ref/DisablePropagation.html +++ b/docs/er/api-ref/DisablePropagation.html @@ -104,7 +104,9 @@
Table 3 FlowLog

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Flow log ID

+

Flow log ID

name

+

name

String

+

String

Flow log name

+

Flow log name

description

+

description

String

+

String

Flow log description

+

Flow log description

project_id

+

project_id

String

+

String

Project ID of the flow log task creator

+

Project ID of the flow log task creator

resource_type

+

resource_type

String

+

String

Resource type. The value is attachment.

+

Resource type. The value is attachment.

resource_id

+

resource_id

String

+

String

Resource ID

+

Resource ID

log_group_id

+

log_group_id

String

+

String

Log group ID

+

Log group ID

log_stream_id

+

log_stream_id

String

+

String

Log stream ID

+

Log stream ID

log_store_type

+

log_store_type

String

+

String

Flow log storage type. LTS is used for log storage.

+

Flow log storage type. LTS is used for log storage.

log_store_name

+

log_store_name

String

+

String

Flow log storage name. This parameter is not supported for now.

+

Flow log storage name. This parameter is not supported for now.

log_aggregation_interval

+

log_aggregation_interval

Integer

+

Integer

Log aggregation time, in seconds. The value ranges from 60 to 600.

+

Log aggregation time, in seconds. The value ranges from 60 to 600.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

state

+

state

String

+

String

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

enabled

+

enabled

Boolean

+

Boolean

Whether to enable flow logs. The value can be true or false.

+

Whether to enable flow logs. The value can be true or false.

-

Response Parameters

None

+

Response Parameters

Status code: 202

+

Accepted

+

None

Example Requests

Deleting a route table propagation

POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/ad838a5e-dbef-22cc-b1d9-cb46bef77ae8/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/disable-propagations
diff --git a/docs/er/api-ref/DisassociateRouteTable.html b/docs/er/api-ref/DisassociateRouteTable.html
index 2a9541683..bcb8d47de 100644
--- a/docs/er/api-ref/DisassociateRouteTable.html
+++ b/docs/er/api-ref/DisassociateRouteTable.html
@@ -73,7 +73,7 @@
 
 

ExportRoutePolicy object

Route that controls outbound traffic. Note that this is not currently supported. This parameter is not supported for now.

+

Route that controls outbound traffic. This parameter is not supported for now.

-

Response Parameters

None

+

Response Parameters

Status code: 202

+

Accepted

+

None

Example Requests

Deleting a route table association

POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f8/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/disassociate
diff --git a/docs/er/api-ref/EnableFlowLog.html b/docs/er/api-ref/EnableFlowLog.html
index 1334399e9..2c6ea383a 100644
--- a/docs/er/api-ref/EnableFlowLog.html
+++ b/docs/er/api-ref/EnableFlowLog.html
@@ -50,143 +50,143 @@
 

Response Parameters

Status code: 202

-
Table 2 Response body parameters

Parameter

+
- - - - - - - -
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

flow_log

+

flow_log

FlowLog object

+

FlowLog object

Flow log details

+

Flow log details

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 3 FlowLog

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/er/api-ref/EnablePropagation.html b/docs/er/api-ref/EnablePropagation.html index 5ba3f329c..92af77800 100644 --- a/docs/er/api-ref/EnablePropagation.html +++ b/docs/er/api-ref/EnablePropagation.html @@ -131,157 +131,157 @@

Response Parameters

Status code: 202

-
Table 3 FlowLog

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Flow log ID

+

Flow log ID

name

+

name

String

+

String

Flow log name

+

Flow log name

description

+

description

String

+

String

Flow log description

+

Flow log description

project_id

+

project_id

String

+

String

Project ID of the flow log task creator

+

Project ID of the flow log task creator

resource_type

+

resource_type

String

+

String

Resource type. The value is attachment.

+

Resource type. The value is attachment.

resource_id

+

resource_id

String

+

String

Resource ID

+

Resource ID

log_group_id

+

log_group_id

String

+

String

Log group ID

+

Log group ID

log_stream_id

+

log_stream_id

String

+

String

Log stream ID

+

Log stream ID

log_store_type

+

log_store_type

String

+

String

Flow log storage type. LTS is used for log storage.

+

Flow log storage type. LTS is used for log storage.

log_store_name

+

log_store_name

String

+

String

Flow log storage name. This parameter is not supported for now.

+

Flow log storage name. This parameter is not supported for now.

log_aggregation_interval

+

log_aggregation_interval

Integer

+

Integer

Log aggregation time, in seconds. The value ranges from 60 to 600.

+

Log aggregation time, in seconds. The value ranges from 60 to 600.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

state

+

state

String

+

String

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

enabled

+

enabled

Boolean

+

Boolean

Whether to enable flow logs. The value can be true or false.

+

Whether to enable flow logs. The value can be true or false.

Table 5 Response header parameters

Parameter

+
- - - - -
Table 5 Response header parameters

Parameter

Type

+

Type

Description

+

Description

X-Client-Token

+

X-Client-Token

String

+

String

Idempotence identifier

+

Idempotence identifier

-
Table 6 Response body parameters

Parameter

+
- - - - - - - -
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

propagation

+

propagation

Propagation object

+

Propagation object

Propagation details

+

Propagation details

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 7 Propagation

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 Propagation

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Unique association ID

+

Unique association ID

project_id

+

project_id

String

+

String

Project ID

+

Project ID

er_id

+

er_id

String

+

String

Enterprise router ID

+

Enterprise router ID

route_table_id

+

route_table_id

String

+

String

Unique ID of the route table

+

Unique ID of the route table

attachment_id

+

attachment_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

resource_id

+

resource_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

route_policy

+

route_policy

ImportRoutePolicy object

+

ImportRoutePolicy object

Route that controls inbound traffic. This parameter is not supported for now.

+

Route that controls inbound traffic. This parameter is not supported for now.

state

+

state

String

+

String

Status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Status. Value options: pending, available, modifying, deleting, deleted, and failed

created_at

+

created_at

String

+

String

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

updated_at

+

updated_at

String

+

String

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

-
Table 8 ImportRoutePolicy

Parameter

+
- - - - - diff --git a/docs/er/api-ref/EnterpriseRouterInstance.html b/docs/er/api-ref/EnterpriseRouterInstance.html index d9b1fe344..d4ca69c25 100644 --- a/docs/er/api-ref/EnterpriseRouterInstance.html +++ b/docs/er/api-ref/EnterpriseRouterInstance.html @@ -1,7 +1,7 @@

Enterprise Routers

-

+

- @@ -137,135 +137,135 @@

Response Parameters

Status code: 200

-
Table 8 ImportRoutePolicy

Parameter

Type

+

Type

Description

+

Description

import_policy_id

+

import_policy_id

String

+

String

ID of the route policy that controls inbound traffic. This parameter is not supported for now.

+

ID of the route policy that controls inbound traffic. This parameter is not supported for now.

Minimum: 0

Maximum: 36

Array of strings

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

associations

+

associations

Array of Association objects

+

Array of Association objects

Route table associations

+

Route table associations

Array Length: 0 - 2000

request_id

+

request_id

String

+

String

Request ID

+

Request ID

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

-
Table 4 Association

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Association

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Unique association ID

+

Unique association ID

Maximum: 36

route_table_id

+

route_table_id

String

+

String

Unique ID of the route table

+

Unique ID of the route table

Maximum: 36

attachment_id

+

attachment_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

Maximum: 36

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

resource_id

+

resource_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

state

+

state

String

+

String

Status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Status. Value options: pending, available, modifying, deleting, deleted, and failed

created_at

+

created_at

String

+

String

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

updated_at

+

updated_at

String

+

String

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

route_policy

+

route_policy

ExportRoutePolicy object

+

ExportRoutePolicy object

Route that controls outbound traffic. Note that this is not currently supported. This parameter is not supported for now.

+

Route that controls outbound traffic. This parameter is not supported for now.

-
Table 5 ExportRoutePolicy

Parameter

+
- - - - - @@ -274,26 +274,26 @@
Table 5 ExportRoutePolicy

Parameter

Type

+

Type

Description

+

Description

export_policy_id

+

export_policy_id

String

+

String

ID of the route policy that controls outbound traffic. This parameter is not supported for now.

+

ID of the route policy that controls outbound traffic. This parameter is not supported for now.

Minimum: 0

Maximum: 36

-
Table 6 PageInfo

Parameter

+
- - - - - - - - diff --git a/docs/er/api-ref/ListAttachments.html b/docs/er/api-ref/ListAttachments.html index 180e12e08..25d7695e1 100644 --- a/docs/er/api-ref/ListAttachments.html +++ b/docs/er/api-ref/ListAttachments.html @@ -1,336 +1,369 @@

Querying Attachments

-

Function

This API is used to query the attachments of the enterprise router.

+

Function

This API is used to query the attachments of the enterprise router.

-

Constraints

  • Filtering query is supported. The filtering criteria include state, resource_type, and resource_id. You can query multiple resources at a time or use combined criteria to query resources.
  • Pagination query is supported. You can use limit and marker together for pagination query.
  • Only sorting by a single field (id, name, description, created_at, or updated_at) is supported.
+

Constraints

  • Filtering query is supported. The filtering criteria include state, resource_type, and resource_id. You can query multiple resources at a time or use combined criteria to query resources.

    +
  • Pagination query is supported. You can use limit and marker together for pagination query.

    +
  • Only sorting by a single field (id, name, description, created_at, or updated_at) is supported.

    +
-

URI

GET /v3/{project_id}/enterprise-router/{er_id}/attachments

+

URI

GET /v3/{project_id}/enterprise-router/{er_id}/attachments

-
Table 6 PageInfo

Parameter

Type

+

Type

Description

+

Description

next_marker

+

next_marker

String

+

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

+

current_count

Integer

+

Integer

Number of resources in the list

+

Number of resources in the list

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

er_id

+

er_id

Yes

+

Yes

String

+

String

Enterprise router ID

+

Enterprise router ID

-
Table 2 Query Parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

limit

+

limit

No

+

No

Integer

+

Integer

Number of records on each page. Value range: 0 to 2000

-

Minimum: 0

-

Maximum: 2000

+

Number of records on each page. Value range: 0 to 2000

+

Minimum: 0

+

Maximum: 2000

marker

+

marker

No

+

No

String

+

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

+

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

state

+

state

No

+

No

Array of strings

+

Array of strings

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request

+

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request

resource_type

+

resource_type

No

+

No

Array of strings

+

Array of strings

Attachment type.

-
  • vpc: VPC attachment
  • vpn: VPN gateway attachment
  • vgw: virtual gateway attachment
+
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

    +

resource_id

+

resource_id

No

+

No

Array of strings

+

Array of strings

Attachment resource IDs

+

Attachment resource IDs

sort_key

+

sort_key

No

+

No

Array of strings

+

Array of strings

Keyword for sorting. The keyword can be id, name, or state. By default, id is used.

+

Keyword for sorting. The keyword can be id, name, or state. By default, id is used.

sort_dir

+

sort_dir

No

+

No

Array of strings

+

Array of strings

Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc.

+

Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc.

-

Request Parameters

None

+

Request Parameters

None

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

attachments

+

attachments

Array of AttachmentDetails objects

+

Array of AttachmentDetails objects

Attachments

+

Attachments

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 4 AttachmentDetails

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
Table 4 AttachmentDetails

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Attachment ID

+

Attachment ID

name

+

name

String

+

String

Attachment name

+

Attachment name

description

+

description

String

+

String

Attachment description

+

Attachment description

state

+

state

String

+

String

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request

+

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, initiating_request, freezed, or invalid.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Attachment tags

+

Attachment tags.

project_id

+

project_id

String

+

String

Project ID

+

Project ID

er_id

+

er_id

String

+

String

er id

+

Enterprise router ID

resource_id

+

resource_id

String

+

String

Attached resource ID on its own service console

+

Attached resource ID on its own service console

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vgw: virtual gateway attachment
  • vpn: VPN gateway attachment
  • vpc: VPC attachment
+

Attachment type.

+
  • vgw: Direct Connect virtual gateway

    +
  • vpn: VPN gateway

    +
  • vpc: VPC

    +
  • cfw: CFW instance

    +

resource_project_id

+

resource_project_id

String

+

String

ID of the project that the resource belongs to

+

ID of the project that the resource belongs to

associated

+

associated

Boolean

+

Boolean

Whether the attachment is associated.

+

Whether the attachment is associated.

route_table_id

+

route_table_id

String

+

String

Association route table ID

+

Association route table ID

+

frozen_scene

+

String

+

Frozen reason. The reason can be account arrears, public security, and violations of laws and regulations. This parameter is not supported.

+

ipv6_enable

+

Boolean

+

Whether to enable IPv6. The value false indicates that IPv6 is disabled, and the value true indicates that IPv6 is enabled. This parameter is not supported.

-
Table 5 Tag

Parameter

+
- - - - - - - -
Table 5 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

-

Minimum: 1

-

Maximum: 128

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +
+

Minimum: 1

+

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

-

Minimum: 0

-

Maximum: 128

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +
+

Minimum: 0

+

Maximum: 255

-
Table 6 PageInfo

Parameter

+
- - - - - - - -
Table 6 PageInfo

Parameter

Type

+

Type

Description

+

Description

next_marker

+

next_marker

String

+

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

+

current_count

Integer

+

Integer

Number of resources in the list

+

Number of resources in the list

-

Example Requests

Querying attachments

-
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231052/attachments
+

Example Requests

Querying attachments

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231052/attachments
-

Example Responses

Status code: 200

-

OK

-
{
+

Example Responses

Status code: 200

+

OK

+
{
   "attachments" : [ {
     "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
     "name" : "vpc-001",
@@ -359,23 +392,23 @@
   "request_id" : "b715e131-3371-4e17-a2de-4f669e24439a"
 }
-

Status Codes

-
- - - - -

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

OK

+

OK

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/er/api-ref/ListAvailabilityZone.html b/docs/er/api-ref/ListAvailabilityZone.html index be61b3a40..36fb90c27 100644 --- a/docs/er/api-ref/ListAvailabilityZone.html +++ b/docs/er/api-ref/ListAvailabilityZone.html @@ -47,16 +47,6 @@

Enterprise router ID

bandwidth_size

-

No

-

Integer

-

Bandwidth size, in Mbit/s

-

Minimum: -1

-
@@ -65,52 +55,52 @@

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

availability_zones

+

availability_zones

Array of AvailableZone objects

+

Array of AvailableZone objects

AZ list

+

AZ list

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 4 AvailableZone

Parameter

+
- - - - - - - - diff --git a/docs/er/api-ref/ListEffectiveRoutes.html b/docs/er/api-ref/ListEffectiveRoutes.html index 63ebe10c5..1f3c682dd 100644 --- a/docs/er/api-ref/ListEffectiveRoutes.html +++ b/docs/er/api-ref/ListEffectiveRoutes.html @@ -84,10 +84,10 @@ - @@ -99,150 +99,172 @@

Response Parameters

Status code: 200

-
Table 4 AvailableZone

Parameter

Type

+

Type

Description

+

Description

code

+

code

String

+

String

AZ code

+

AZ code

state

+

state

String

+

String

Whether the AZ is available. Value options: available and unavailable

+

Whether the AZ is available. Value options: available and unavailable

Array of strings

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

routes

+

routes

Array of EffectiveRoute objects

+

Array of EffectiveRoute objects

Routes

+

Routes

request_id

+

request_id

String

+

String

Request ID

+

Request ID

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

-
Table 4 EffectiveRoute

Parameter

+
- - - - - - - - - - - - - - - - - - - - + + + + + + + +
Table 4 EffectiveRoute

Parameter

Type

+

Type

Description

+

Description

route_id

+

route_id

String

+

String

Route ID

+

Route ID

destination

+

destination

String

+

String

Destination address of the route

+

Destination address of the route

next_hops

+

next_hops

Array of RouteAttachment objects

+

Array of EffectiveRouteAttachment objects

Next hops of the routes

+

Next hops of the routes

is_blackhole

+

is_blackhole

Boolean

+

Boolean

Whether the route is a blackhole route

+

Whether the route is a blackhole route

route_type

+

route_type

String

+

String

Route type. Value options: static and propagation

+

Route type. Value options: static and propagation

address_group_id

+

sync_state

String

+

String

IP address group ID. This parameter is not supported for now.

+

Route synchronization status. The value can be unsynchronized, synchronizing, revoking, or synchronized. This parameter is not supported.

+

address_group_id

+

String

+

IP address group ID. This parameter is not supported.

+

description

+

String

+

Route description.

-
Table 5 RouteAttachment

Parameter

+
- - - - - - - - - - - + + + +
Table 5 EffectiveRouteAttachment

Parameter

Type

+

Type

Description

+

Description

resource_id

+

resource_id

String

+

String

Attached resource ID

+

Attached resource ID

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +

Attachment type.

+
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

attachment_id

+

attachment_id

String

+

String

Attachment ID

+

Attachment ID

+

priority

+

Integer

+

Route priority. The value is fixed at 1 for common routes.

-
Table 6 PageInfo

Parameter

+
- - - - - - - - @@ -258,10 +280,12 @@ "routes" : [ { "route_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289", "destination" : "192.168.0.0/16", + "description" : "static route", "next_hops" : [ { "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d", "resource_type" : "vpc", - "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289" + "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289", + "priority" : 0 } ], "is_blackhole" : false, "route_type" : "static" diff --git a/docs/er/api-ref/ListEnterpriseRouters.html b/docs/er/api-ref/ListEnterpriseRouters.html index 774336aa8..9a3d90973 100644 --- a/docs/er/api-ref/ListEnterpriseRouters.html +++ b/docs/er/api-ref/ListEnterpriseRouters.html @@ -77,7 +77,7 @@ - + + + + +
Table 6 PageInfo

Parameter

Type

+

Type

Description

+

Description

next_marker

+

next_marker

String

+

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

+

current_count

Integer

+

Integer

Number of resources in the list

+

Number of resources in the list

Array of strings

Enterprise router status. Value options: pending, available, modifying, deleting, deleted, failed and freezed

+

Resource status. Value options: pending, available, modifying, deleting, deleted, failed, or freezed.

id

@@ -98,6 +98,18 @@

Attachment resource IDs

owned_by_self

+

No

+

Boolean

+

Whether the resources belong to the current account.

+
  • If the value is true, the resources belong to the current account.

    +
  • If the value is false, the resources include those in the current account and those shared with the current account.

    +
+

sort_key

No

@@ -124,228 +136,293 @@

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

instances

+

instances

Array of EnterpriseRouter objects

+

Array of EnterpriseRouter objects

Enterprise routers

+

Enterprise routers

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 4 EnterpriseRouter

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
Table 4 EnterpriseRouter

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Enterprise router ID

+

Enterprise router ID

name

+

name

String

+

String

Enterprise router name

+

Enterprise router name

description

+

description

String

+

String

Supplementary information about an enterprise router

+

Supplementary information about an enterprise router

state

+

state

String

+

String

Enterprise router status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Resource status. The value can be pending, available, modifying, deleting, deleted, failed, or freezed.

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Tag information

+

Tag information

charge_mode

+

charge_mode

String

+

String

Billing mode (pay-per-use)

+

Billing mode (pay-per-use)

Default: postPaid

created_at

+

instance_type

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Instance type. This parameter is not supported.

updated_at

+

created_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

enterprise_project_id

+

updated_at

String

+

String

Enterprise project ID

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

project_id

+

enterprise_project_id

String

+

String

Project ID

+

Enterprise project ID

asn

+

project_id

Long

+

String

Enterprise router BGP ASN

+

Project ID

enable_default_propagation

+

asn

Boolean

+

Long

Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled.

+

Enterprise router BGP ASN

enable_default_association

+

support_multicast

Boolean

+

Boolean

Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled.

+

Whether an enterprise router supports multicast. The default value is false, indicating that multicast is disabled. This parameter is not supported.

default_propagation_route_table_id

+

enable_default_propagation

String

+

Boolean

Default propagation route table ID

+

Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled.

default_association_route_table_id

+

enable_default_association

String

+

Boolean

Default association route table ID

+

Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled.

availability_zone_ids

+

default_propagation_route_table_id

Array of strings

+

String

AZs where the enterprise router is located

+

Default propagation route table ID

auto_accept_shared_attachments

+

default_association_route_table_id

Boolean

+

String

Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled.

+

Default association route table ID

cidr_blocks

+

availability_zone_ids

Array of strings

+

Array of strings

Enterprise router CIDR block. This parameter is not supported for now.

+

AZs where the enterprise router is located

+

auto_accept_shared_attachments

+

Boolean

+

Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled.

+

cidr_blocks

+

Array of strings

+

CIDR block of an enterprise router. This parameter is not supported.

+

bandwidth

+

Bandwidth object

+

Bandwidth request body. This parameter is not supported.

+

billing_info

+

String

+

Order information. This parameter is not supported.

+

frozen_scene

+

String

+

Frozen reason. The reason can be account arrears, public security, and violations of laws and regulations. This parameter is not supported.

-
Table 5 Tag

Parameter

+
- - - - - - - -
Table 5 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

-
Table 6 PageInfo

Parameter

+
- - - - - - +
Table 6 Bandwidth

Parameter

Type

+

Type

Description

+

Description

next_marker

+

size

String

+

Integer

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Bandwidth, in Mbit/s. The default value is 0, indicating that the bandwidth is not limited. The value -1 indicates that the bandwidth is limited to 2 kbit/s. This parameter is not supported.

+

Minimum: -1

+

Default: 0

current_count

+
+
+ +
+ + + + + - - + + + + diff --git a/docs/er/api-ref/ListFlowLogs.html b/docs/er/api-ref/ListFlowLogs.html index 2c1061713..03391f259 100644 --- a/docs/er/api-ref/ListFlowLogs.html +++ b/docs/er/api-ref/ListFlowLogs.html @@ -118,176 +118,183 @@

Response Parameters

Status code: 200

-
Table 7 PageInfo

Parameter

+

Type

+

Description

+

next_marker

Integer

+

String

Number of resources in the list

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

current_count

+

Integer

+

Number of resources in the list

Table 3 Response body parameters

Parameter

+
- - - - - - - - - - - + + + +
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

flow_logs

+

flow_logs

Array of FlowLog objects

+

Array of FlowLog objects

Flow log details

+

Flow log details

request_id

+

request_id

String

+

String

Request ID

+

Request ID

page_info

+

total_count

PageInfo object

+

Long

Pagination query information

+

Total count

+

page_info

+

PageInfo object

+

Pagination query information

-
Table 4 FlowLog

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 FlowLog

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Flow log ID

+

Flow log ID

name

+

name

String

+

String

Flow log name

+

Flow log name

description

+

description

String

+

String

Flow log description

+

Flow log description

project_id

+

project_id

String

+

String

Project ID of the flow log task creator

+

Project ID of the flow log task creator

resource_type

+

resource_type

String

+

String

Resource type. The value is attachment.

+

Resource type. The value is attachment.

resource_id

+

resource_id

String

+

String

Resource ID

+

Resource ID

log_group_id

+

log_group_id

String

+

String

Log group ID

+

Log group ID

log_stream_id

+

log_stream_id

String

+

String

Log stream ID

+

Log stream ID

log_store_type

+

log_store_type

String

+

String

Flow log storage type. LTS is used for log storage.

+

Flow log storage type. LTS is used for log storage.

log_store_name

+

log_store_name

String

+

String

Flow log storage name. This parameter is not supported for now.

+

Flow log storage name. This parameter is not supported for now.

log_aggregation_interval

+

log_aggregation_interval

Integer

+

Integer

Log aggregation time, in seconds. The value ranges from 60 to 600.

+

Log aggregation time, in seconds. The value ranges from 60 to 600.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

state

+

state

String

+

String

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed

enabled

+

enabled

Boolean

+

Boolean

Whether to enable flow logs. The value can be true or false.

+

Whether to enable flow logs. The value can be true or false.

-
Table 5 PageInfo

Parameter

+
- - - - - - - - @@ -320,7 +327,8 @@ "next_marker" : "1", "current_count" : 1 }, - "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" + "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9", + "total_count" : 1 }

Status Codes

diff --git a/docs/er/api-ref/ListProjectTags.html b/docs/er/api-ref/ListProjectTags.html index 269db8855..79fa61964 100644 --- a/docs/er/api-ref/ListProjectTags.html +++ b/docs/er/api-ref/ListProjectTags.html @@ -30,12 +30,13 @@
- @@ -47,45 +48,45 @@

Response Parameters

Status code: 200

-
Table 5 PageInfo

Parameter

Type

+

Type

Description

+

Description

next_marker

+

next_marker

String

+

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

+

current_count

Integer

+

Integer

Number of resources in the list

+

Number of resources in the list

String

Resource type.

+

Tagged resource type.

  • instance: enterprise router

  • route-table: route table

  • vpc-attachment: VPC attachment

  • vgw-attachment: virtual gateway attachment

  • vpn-attachment: VPN gateway attachment

    +
  • cfw-attachment: CFW instance attachment

Table 2 Response body parameters

Parameter

+
- - - - -
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

tags

+

tags

Array of Tags objects

+

Array of Tags objects

Tags

+

Tags

-
Table 3 Tags

Parameter

+
- - - - - - - - diff --git a/docs/er/api-ref/ListPropagations.html b/docs/er/api-ref/ListPropagations.html index b74b91ad6..d01cf3b6f 100644 --- a/docs/er/api-ref/ListPropagations.html +++ b/docs/er/api-ref/ListPropagations.html @@ -95,10 +95,10 @@ - @@ -108,7 +108,7 @@ -
Table 3 Tags

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key, which cannot be empty and can contain a maximum of 127 Unicode characters.

+

Tag key, which cannot be empty and can contain a maximum of 127 Unicode characters.

values

+

values

Array of strings

+

Array of strings

Tag values. Each value can contain a maximum of 255 Unicode characters.

+

Tag values. Each value can contain a maximum of 255 Unicode characters.

Array of strings

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

Array of strings

Enterprise router status. Value options: pending, available, modifying, deleting, deleted, failed and freezed

+

Resource status. Value options: pending, available, modifying, deleting, deleted, failed, or freezed.

sort_key

@@ -137,146 +137,146 @@

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

propagations

+

propagations

Array of Propagation objects

+

Array of Propagation objects

Route propagations

+

Route propagations

Array Length: 0 - 2000

request_id

+

request_id

String

+

String

Request ID

+

Request ID

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

-
Table 4 Propagation

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Propagation

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Unique association ID

+

Unique association ID

project_id

+

project_id

String

+

String

Project ID

+

Project ID

er_id

+

er_id

String

+

String

Enterprise router ID

+

Enterprise router ID

route_table_id

+

route_table_id

String

+

String

Unique ID of the route table

+

Unique ID of the route table

attachment_id

+

attachment_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment

    -
  • vpn: VPN gateway attachment

    -
  • vgw: virtual gateway attachment

    +
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

resource_id

+

resource_id

String

+

String

Unique ID of the attachment

+

Unique ID of the attachment

route_policy

+

route_policy

ImportRoutePolicy object

+

ImportRoutePolicy object

Route that controls inbound traffic. This parameter is not supported for now.

+

Route that controls inbound traffic. This parameter is not supported for now.

state

+

state

String

+

String

Status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Status. Value options: pending, available, modifying, deleting, deleted, and failed

created_at

+

created_at

String

+

String

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

updated_at

+

updated_at

String

+

String

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

+

Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ.

-
Table 5 ImportRoutePolicy

Parameter

+
- - - - - @@ -285,26 +285,26 @@
Table 5 ImportRoutePolicy

Parameter

Type

+

Type

Description

+

Description

import_policy_id

+

import_policy_id

String

+

String

ID of the route policy that controls inbound traffic. This parameter is not supported for now.

+

ID of the route policy that controls inbound traffic. This parameter is not supported for now.

Minimum: 0

Maximum: 36

-
Table 6 PageInfo

Parameter

+
- - - - - - - - diff --git a/docs/er/api-ref/ListRouteTables.html b/docs/er/api-ref/ListRouteTables.html index 043419149..e8f235913 100644 --- a/docs/er/api-ref/ListRouteTables.html +++ b/docs/er/api-ref/ListRouteTables.html @@ -126,198 +126,207 @@

Response Parameters

Status code: 200

-
Table 6 PageInfo

Parameter

Type

+

Type

Description

+

Description

next_marker

+

next_marker

String

+

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

+

current_count

Integer

+

Integer

Number of resources in the list

+

Number of resources in the list

Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

route_tables

+

route_tables

Array of RouteTable objects

+

Array of RouteTable objects

Route tables

+

Route tables

request_id

+

request_id

String

+

String

Request ID

+

Request ID

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

-
Table 4 RouteTable

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 RouteTable

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Route table ID

+

Route table ID

name

+

name

String

+

String

Route table name

+

Route table name

description

+

description

String

+

String

Supplementary information

+

Supplementary information

is_default_association

+

is_default_association

Boolean

+

Boolean

Whether the route table is the default association route table.

+

Whether the route table is the default association route table.

Default: false

is_default_propagation

+

is_default_propagation

Boolean

+

Boolean

Whether the route table is the default propagation route table.

+

Whether the route table is the default propagation route table.

state

+

state

String

+

String

Route table status. The value can be pending, available, deleting, deleted, or failed.

+

Route table status. The value can be pending, available, deleting, deleted, or failed.

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Tag

+

Tag

bgp_options

+

bgp_options

BgpOptions object

+

BgpOptions object

BGP route selection parameters. This parameter is not supported for now.

+

BGP route selection parameters. This parameter is not supported for now.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

-
Table 5 Tag

Parameter

+
- - - - - - - -
Table 5 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

-
Table 6 BgpOptions

Parameter

+
- - - - - - - -
Table 6 BgpOptions

Parameter

Type

+

Type

Description

+

Description

load_balancing_as_path_ignore

+

load_balancing_as_path_ignore

Boolean

+

Boolean

BGP option to specify that AS-Path attributes are not compared during load balancing. This parameter is not supported for now.

+

BGP option to specify that AS-Path attributes are not compared during load balancing. This parameter is not supported for now.

load_balancing_as_path_relax

+

load_balancing_as_path_relax

Boolean

+

Boolean

BGP option to specify that AS-Path attributes with the same length are not compared during load balancing. This parameter is not supported for now.

+

BGP option to specify that AS-Path attributes with the same length are not compared during load balancing. This parameter is not supported for now.

-
Table 7 PageInfo

Parameter

+
- - - - - - - - diff --git a/docs/er/api-ref/ListStaticRoutes.html b/docs/er/api-ref/ListStaticRoutes.html index 9ef3d2d3b..91c723fe0 100644 --- a/docs/er/api-ref/ListStaticRoutes.html +++ b/docs/er/api-ref/ListStaticRoutes.html @@ -1,308 +1,332 @@

Querying Static Routes

-

Function

This API is used to query static routes.

+

Function

This API is used to query static routes.

-

Constraints

  • Pagination query is supported. The supported query criteria are destination, attachment_id, resource_type, and type.
  • Only sorting by a single field (id, destination, created_at, or updated_at) is supported.
+

Constraints

  • Pagination query is supported. The supported query criteria are destination, attachment_id, resource_type, and type.

    +
  • Only sorting by a single field (id, destination, created_at, or updated_at) is supported.

    +
-

URI

GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes

+

URI

GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes

-
Table 7 PageInfo

Parameter

Type

+

Type

Description

+

Description

next_marker

+

next_marker

String

+

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

+

current_count

Integer

+

Integer

Number of resources in the list

+

Number of resources in the list

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

route_table_id

+

route_table_id

Yes

+

Yes

String

+

String

Route table ID

+

Route table ID

-
Table 2 Query Parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Query Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

limit

+

limit

No

+

No

Integer

+

Integer

Number of records on each page. Value range: 0 to 2000

-

Minimum: 0

-

Maximum: 2000

+

Number of records on each page. Value range: 0 to 2000

+

Minimum: 0

+

Maximum: 2000

marker

+

marker

No

+

No

String

+

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

+

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

destination

+

destination

No

+

No

Array of strings

+

Array of strings

Destination address of the route

+

Destination address of the route

attachment_id

+

attachment_id

No

+

No

Array of strings

+

Array of strings

Attachment ID

+

Attachment ID

resource_type

+

resource_type

No

+

No

Array of strings

+

Array of strings

Attachment type.

-
  • vpc: VPC attachment
+
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

    +

sort_key

+

sort_key

No

+

No

Array of strings

+

Array of strings

Keyword for sorting. The keyword can be id, name, or state. By default, id is used.

+

Keyword for sorting. The keyword can be id, name, or state. By default, id is used.

sort_dir

+

sort_dir

No

+

No

Array of strings

+

Array of strings

Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc.

+

Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc.

-

Request Parameters

None

+

Request Parameters

None

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

routes

+

routes

Array of Route objects

+

Array of Route objects

Routes

+

Routes

request_id

+

request_id

String

+

String

Request ID

+

Request ID

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

-
Table 4 Route

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
Table 4 Route

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Route ID

+

Route ID

type

+

type

String

+

String

Route type. The value is static.

+

Route type. The value is static.

state

+

state

String

+

String

Route status. Value options: pending, available, modifying, deleting, deleted, and failed

+

Route status. Value options: pending, available, modifying, deleting, deleted, and failed

is_blackhole

+

is_blackhole

Boolean

+

Boolean

Whether the route is a blackhole route

+

Whether the route is a blackhole route

destination

+

destination

String

+

String

Destination address of the route

+

Destination address of the route

attachments

+

attachments

Array of RouteAttachment objects

+

Array of RouteAttachment objects

Next hops

+

Next hops

route_table_id

+

route_table_id

String

+

String

Route table ID

+

Route table ID

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

description

+

String

+

Route description.

-
Table 5 RouteAttachment

Parameter

+
- - - - - - - - - - - + + + +
Table 5 RouteAttachment

Parameter

Type

+

Type

Description

+

Description

resource_id

+

resource_id

String

+

String

Attached resource ID

+

Attached resource ID

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment
+

Attachment type.

+
  • vpc: VPC

    +
  • vpn: VPN gateway

    +
  • vgw: Direct Connect virtual gateway

    +
  • cfw: CFW instance

    +

attachment_id

+

attachment_id

String

+

String

Attachment ID

+

Attachment ID

+

priority

+

Integer

+

Route priority, the common route is 1

-
Table 6 PageInfo

Parameter

+
- - - - - - - -
Table 6 PageInfo

Parameter

Type

+

Type

Description

+

Description

next_marker

+

next_marker

String

+

String

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

current_count

+

current_count

Integer

+

Integer

Number of resources in the list

+

Number of resources in the list

-

Example Requests

Querying static routes

-
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/915a14a6-867b-4af7-83d1-70efceb146f5/static-routes
+

Example Requests

Querying static routes

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/915a14a6-867b-4af7-83d1-70efceb146f5/static-routes
-

Example Responses

Status code: 200

-

OK

-
{
+

Example Responses

Status code: 200

+

OK

+
{
   "routes" : [ {
     "id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
     "type" : "static",
     "destination" : "192.168.0.0/16",
+    "description" : "static route",
     "attachments" : [ {
       "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
       "resource_type" : "vpc",
@@ -320,23 +344,23 @@
   "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

OK

+

OK

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/er/api-ref/ListVpcAttachments.html b/docs/er/api-ref/ListVpcAttachments.html index ec9c43fe4..0cf099a2b 100644 --- a/docs/er/api-ref/ListVpcAttachments.html +++ b/docs/er/api-ref/ListVpcAttachments.html @@ -128,194 +128,257 @@

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

vpc_attachments

+

vpc_attachments

Array of VpcAttachmentDetails objects

+

Array of VpcAttachmentDetails objects

VPC attachments

+

VPC attachments

page_info

+

page_info

PageInfo object

+

PageInfo object

Pagination query information

+

Pagination query information

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 4 VpcAttachmentDetails

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
Table 4 VpcAttachmentDetails

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

VPC attachment ID

+

VPC attachment ID

name

+

name

String

+

String

VPC attachment name

+

VPC attachment name

vpc_id

+

vpc_id

String

+

String

VPC id

+

VPC id

virsubnet_id

+

virsubnet_id

String

+

String

VPC subnet ID

+

VPC subnet ID

auto_create_vpc_routes

+

auto_create_vpc_routes

Boolean

+

Boolean

The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC.

+

The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC.

Default: false

state

+

state

String

+

String

VPC attachment status. Value options: pending, available, modifying, deleting, deleted, failed, initiating_request, rejected, and pending_acceptance

+

VPC attachment status. The value can be pending, available, modifying, deleting, deleted, failed, initiating_request, rejected, pending_acceptance, freezed, or invalid.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Tag information

+

Tag information

description

+

description

String

+

String

Supplementary information about the VPC attachment

+

Supplementary information about the VPC attachment

project_id

+

project_id

String

+

String

Project ID

+

Project ID

vpc_project_id

+

vpc_project_id

String

+

String

ID of the project that the VPC belongs to

+

ID of the project that the VPC belongs to

ipv6_enable

+

ipv6_enable

Boolean

+

Boolean

The default value is false. If the value is true, IPv6 is enabled for the VPC attachment. This parameter is not supported for now.

+

The default value is false. If the value is true, IPv6 is enabled for the VPC attachment. This parameter is not supported for now.

Default: false

route_synchronization

+

RouteSynchronization object

+

Route synchronization configuration. This parameter is not supported.

+

frozen_scene

+

String

+

Frozen reason. The reason can be account arrears, public security, and violations of laws and regulations. This parameter is not supported.

+
-
Table 5 Tag

Parameter

+
- - - - - - - -
Table 5 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +

Minimum: 1

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +

Minimum: 0

-

Maximum: 128

+

Maximum: 255

-
Table 6 PageInfo

Parameter

+
- - - - - - - - + + + + + + + + + + +
Table 6 RouteSynchronization

Parameter

Type

+

Type

Description

+

Description

next_marker

+

route_synchronization_enable

String

+

Boolean

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

Whether to enable route synchronization.

current_count

+

vpc_route_table_type

Integer

+

String

Number of resources in the list

+

VPC route table where routes are to be synchronized.

+

route_type

+

String

+

Type of the route to be synchronized.

+

conflict_policy

+

String

+

A conflict policy that specifies whether to synchronize routes with the same destination and next hop to the VPC route table.

+
+
+ +
+ + + + + + + + + + + diff --git a/docs/er/api-ref/Propagation.html b/docs/er/api-ref/Propagation.html index 6c348c9ff..049b8f58e 100644 --- a/docs/er/api-ref/Propagation.html +++ b/docs/er/api-ref/Propagation.html @@ -1,7 +1,7 @@

Propagations

-

+

Table 7 PageInfo

Parameter

+

Type

+

Description

+

next_marker

+

String

+

Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

+

current_count

+

Integer

+

Number of resources in the list

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID

+

Project ID

er_id

+

er_id

Yes

+

Yes

String

+

String

Enterprise router ID

+

Enterprise router ID

attachment_id

+

attachment_id

Yes

+

Yes

String

+

String

Attachment ID

+

Attachment ID

-

Request Parameters

None

+

Request Parameters

None

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 2 Response body parameters

Parameter

+
- - - - - - - -
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

attachment

+

attachment

AttachmentResponse object

+

AttachmentResponse object

Attachment basic information

+

Attachment basic information

request_id

+

request_id

String

+

String

Request ID

+

Request ID

-
Table 3 AttachmentResponse

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
Table 3 AttachmentResponse

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Attachment name

+

Attachment name

id

+

id

String

+

String

Attachment ID

+

Attachment ID

description

+

description

String

+

String

Supplementary information

+

Supplementary information

state

+

state

String

+

String

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request

+

Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, initiating_request, freezed, or invalid.

created_at

+

created_at

String

+

String

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

+

updated_at

String

+

String

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

+

Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ

tags

+

tags

Array of Tag objects

+

Array of Tag objects

Attachment tags

+

Attachment tags.

project_id

+

project_id

String

+

String

Project ID

+

Project ID

resource_id

+

resource_id

String

+

String

Attached resource ID on its own service console

+

Attached resource ID on its own service console

resource_type

+

resource_type

String

+

String

Attachment type.

-
  • vpc: VPC attachment
+

Attachment type.

+
  • vpc: VPC

    +

resource_project_id

+

resource_project_id

String

+

String

ID of the project that the resource belongs to

+

ID of the project that the resource belongs to

+

ipv6_enable

+

Boolean

+

Whether to enable IPv6. The value false indicates that IPv6 is disabled, and the value true indicates that IPv6 is enabled. This parameter is not supported.

-
Table 4 Tag

Parameter

+
- - - - - - - -
Table 4 Tag

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

-

Minimum: 1

-

Maximum: 128

+

Tag key. The key:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Cannot start with sys because it indicates a system tag.

    +
  • Cannot be empty (the length cannot be 0).

    +
  • Can contain 1 to 128 characters.

    +
+

Minimum: 1

+

Maximum: 128

value

+

value

String

+

String

Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@).

-

Minimum: 0

-

Maximum: 128

+

Tag value. The value:

+
  • Can contain UTF-8 letters, digits, spaces, and the following characters: _.:=+-@.

    +
  • Can be empty or null.

    +
  • Can contain 0 to 255 characters.

    +
+

Minimum: 0

+

Maximum: 255

-

Example Requests

Rejecting a shared attachment

-
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/attachments/6f83b848-8331-4271-ac0c-ef94b7686401/reject
+

Example Requests

Rejecting a shared attachment

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/attachments/6f83b848-8331-4271-ac0c-ef94b7686401/reject
-

Example Responses

Status code: 200

-

OK

-
{
+

Example Responses

Status code: 200

+

OK

+
{
   "attachment" : {
     "id" : "6f83b848-8331-4271-ac0c-ef94b7686402,",
     "name" : "vpc attachment,",
     "description" : "VPC attachment",
-    "state" : "avaliable",
+    "state" : "available",
     "created_at" : "2020-03-11T15:13:31Z",
     "updated_at" : "2020-03-11T15:13:31Z",
     "tags" : [ ],
     "project_id" : "0605767a9980d5762fbcc00b3537e757",
     "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
     "resource_type" : "vpc",
-    "resource_project_id" : null
+    "resource_project_id" : "0605767a9980d5762fbcc00b3537e751"
   },
   "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - -

Status Code

Description

+

Description

200

+

200

OK

+

OK

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/er/api-ref/Route.html b/docs/er/api-ref/Route.html index f25e42af5..22ab97c27 100644 --- a/docs/er/api-ref/Route.html +++ b/docs/er/api-ref/Route.html @@ -1,7 +1,7 @@

Routes

-

+