diff --git a/docs/er/api-ref/ALL_META.TXT.json b/docs/er/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..b8b015cca --- /dev/null +++ b/docs/er/api-ref/ALL_META.TXT.json @@ -0,0 +1,1446 @@ +[ + { + "dockw":"API Reference" + }, + { + "uri":"er_02_0001.html", + "node_id":"er_02_0001.xml", + "product_code":"er", + "code":"1", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"er_02_0014.html", + "node_id":"er_02_0014.xml", + "product_code":"er", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"APIs", + "githuburl":"" + }, + { + "uri":"EnterpriseRouterInstance.html", + "node_id":"enterpriserouterinstance.xml", + "product_code":"er", + "code":"3", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Enterprise Routers", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Enterprise Routers", + "githuburl":"" + }, + { + "uri":"CreateEnterpriseRouter.html", + "node_id":"createenterpriserouter.xml", + "product_code":"er", + "code":"4", + "des":"This API is used to create an enterprise router. If both Default Route Table Association and Default Route Table Propagation are enabled, the system will create a route t", + "doc_type":"api", + "kw":"Creating an Enterprise Router,Enterprise Routers,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating an Enterprise Router", + "githuburl":"" + }, + { + "uri":"UpdateEnterpriseRouter.html", + "node_id":"updateenterpriserouter.xml", + "product_code":"er", + "code":"5", + "des":"This API is used to update basic information about the enterprise router.Information (except name and description) can be updated only when the enterprise router is in th", + "doc_type":"api", + "kw":"Updating an Enterprise Router,Enterprise Routers,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Updating an Enterprise Router", + "githuburl":"" + }, + { + "uri":"ShowEnterpriseRouter.html", + "node_id":"showenterpriserouter.xml", + "product_code":"er", + "code":"6", + "des":"This API is used to query details about an enterprise router.GET /v3/{project_id}/enterprise-router/instances/{er_id}NoneStatus code: 200Querying details about an enterpr", + "doc_type":"api", + "kw":"Querying Details About an Enterprise Router,Enterprise Routers,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Details About an Enterprise Router", + "githuburl":"" + }, + { + "uri":"ListEnterpriseRouters.html", + "node_id":"listenterpriserouters.xml", + "product_code":"er", + "code":"7", + "des":"This API is used to query enterprise routers.Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together. O", + "doc_type":"api", + "kw":"Querying Enterprise Routers,Enterprise Routers,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Enterprise Routers", + "githuburl":"" + }, + { + "uri":"DeleteEnterpriseRouter.html", + "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.", + "doc_type":"api", + "kw":"Deleting an Enterprise Router,Enterprise Routers,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting an Enterprise Router", + "githuburl":"" + }, + { + "uri":"VPCAttachment.html", + "node_id":"vpcattachment.xml", + "product_code":"er", + "code":"9", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPC Attachments", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"VPC Attachments", + "githuburl":"" + }, + { + "uri":"CreateVpcAttachment.html", + "node_id":"createvpcattachment.xml", + "product_code":"er", + "code":"10", + "des":"This API is used to create a VPC attachment for an enterprise router.POST /v3/{project_id}/enterprise-router/{er_id}/vpc-attachmentsStatus code: 202Creating a VPC attachm", + "doc_type":"api", + "kw":"Creating a VPC Attachment,VPC Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating a VPC Attachment", + "githuburl":"" + }, + { + "uri":"UpdateVpcAttachment.html", + "node_id":"updatevpcattachment.xml", + "product_code":"er", + "code":"11", + "des":"This API is used to update basic information about a VPC attachment.PUT /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}Status code: 200Upda", + "doc_type":"api", + "kw":"Updating a VPC Attachment,VPC Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Updating a VPC Attachment", + "githuburl":"" + }, + { + "uri":"ShowVpcAttachment.html", + "node_id":"showvpcattachment.xml", + "product_code":"er", + "code":"12", + "des":"This API is used to query details about a VPC attachment.GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}NoneStatus code: 200Querying de", + "doc_type":"api", + "kw":"Querying Details About a VPC Attachment,VPC Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Details About a VPC Attachment", + "githuburl":"" + }, + { + "uri":"ListVpcAttachments.html", + "node_id":"listvpcattachments.xml", + "product_code":"er", + "code":"13", + "des":"This API is used to query the VPC attachments of the enterprise router.VPC attachments can be queried in the following methods:Filtering query is supported. You can query", + "doc_type":"api", + "kw":"Querying VPC Attachments,VPC Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying VPC Attachments", + "githuburl":"" + }, + { + "uri":"DeleteVpcAttachment.html", + "node_id":"deletevpcattachment.xml", + "product_code":"er", + "code":"14", + "des":"This API is used to delete a VPC attachment.A VPC attachment can be deleted only when it is in the available, deleting, or failed state.DELETE /v3/{project_id}/enterprise", + "doc_type":"api", + "kw":"Deleting a VPC Attachment,VPC Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting a VPC Attachment", + "githuburl":"" + }, + { + "uri":"Attachments.html", + "node_id":"attachments.xml", + "product_code":"er", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Attachments", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Attachments", + "githuburl":"" + }, + { + "uri":"UpdateAttachment.html", + "node_id":"updateattachment.xml", + "product_code":"er", + "code":"16", + "des":"This API is used to update basic information about an attachment.PUT /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}Status code: 200Updating an att", + "doc_type":"api", + "kw":"Updating an Attachment,Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Updating an Attachment", + "githuburl":"" + }, + { + "uri":"ShowAttachment.html", + "node_id":"showattachment.xml", + "product_code":"er", + "code":"17", + "des":"This API is used to query details about an attachment.GET /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}NoneStatus code: 200Querying details about", + "doc_type":"api", + "kw":"Querying Details About an Attachment,Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Details About an Attachment", + "githuburl":"" + }, + { + "uri":"ListAttachments.html", + "node_id":"listattachments.xml", + "product_code":"er", + "code":"18", + "des":"This API is used to query the attachments of the enterprise router.Filtering query is supported. The filtering criteria include state, resource_type, and resource_id. You", + "doc_type":"api", + "kw":"Querying Attachments,Attachments,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Attachments", + "githuburl":"" + }, + { + "uri":"RouteTable.html", + "node_id":"routetable.xml", + "product_code":"er", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Route Tables", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Route Tables", + "githuburl":"" + }, + { + "uri":"CreateRouteTable.html", + "node_id":"createroutetable.xml", + "product_code":"er", + "code":"20", + "des":"This API is used to create a route table. A route table is the basis for an enterprise router to send and receive packets. It contains attachment associations, propagatio", + "doc_type":"api", + "kw":"Creating a Route Table,Route Tables,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating a Route Table", + "githuburl":"" + }, + { + "uri":"UpdateRouteTable.html", + "node_id":"updateroutetable.xml", + "product_code":"er", + "code":"21", + "des":"This API is used to update basic information about a route table, such as the name and description.PUT /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_tabl", + "doc_type":"api", + "kw":"Updating Route Table Information,Route Tables,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Updating Route Table Information", + "githuburl":"" + }, + { + "uri":"ShowRouteTable.html", + "node_id":"showroutetable.xml", + "product_code":"er", + "code":"22", + "des":"This API is used to query details about a route table.GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}NoneStatus code: 200Querying details abo", + "doc_type":"api", + "kw":"Querying Details About a Route Table,Route Tables,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Details About a Route Table", + "githuburl":"" + }, + { + "uri":"ListRouteTables.html", + "node_id":"listroutetables.xml", + "product_code":"er", + "code":"23", + "des":"This API is used to query route tables.Pagination query is supported. The supported query criteria are state, is_default_propagation_route_table, and is_default_associati", + "doc_type":"api", + "kw":"Querying Route Tables,Route Tables,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Route Tables", + "githuburl":"" + }, + { + "uri":"DeleteRouteTable.html", + "node_id":"deleteroutetable.xml", + "product_code":"er", + "code":"24", + "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.", + "doc_type":"api", + "kw":"Deleting a Route Table,Route Tables,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting a Route Table", + "githuburl":"" + }, + { + "uri":"Association.html", + "node_id":"association.xml", + "product_code":"er", + "code":"25", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Associations", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Associations", + "githuburl":"" + }, + { + "uri":"AssociateRouteTable.html", + "node_id":"associateroutetable.xml", + "product_code":"er", + "code":"26", + "des":"This API is used to create a route association. Each attachment only can be associated with one route table of its enterprise router for packet forwarding.POST /v3/{proje", + "doc_type":"api", + "kw":"Creating a Route Association,Associations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating a Route Association", + "githuburl":"" + }, + { + "uri":"ListAssociations.html", + "node_id":"listassociations.xml", + "product_code":"er", + "code":"27", + "des":"This API is used to query route associations.Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (id, c", + "doc_type":"api", + "kw":"Querying Route Associations,Associations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Route Associations", + "githuburl":"" + }, + { + "uri":"DisassociateRouteTable.html", + "node_id":"disassociateroutetable.xml", + "product_code":"er", + "code":"28", + "des":"This API is used to delete an association from the route table of an enterprise router for an attachment.POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{rou", + "doc_type":"api", + "kw":"Deleting a Route Association,Associations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting a Route Association", + "githuburl":"" + }, + { + "uri":"Propagation.html", + "node_id":"propagation.xml", + "product_code":"er", + "code":"29", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Propagations", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Propagations", + "githuburl":"" + }, + { + "uri":"EnablePropagation.html", + "node_id":"enablepropagation.xml", + "product_code":"er", + "code":"30", + "des":"This API is used to create a route propagation. A propagation can be created for each attachment to propagate routes to one or more route tables on an enterprise router.P", + "doc_type":"api", + "kw":"Creating a Route Propagation,Propagations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating a Route Propagation", + "githuburl":"" + }, + { + "uri":"ListPropagations.html", + "node_id":"listpropagations.xml", + "product_code":"er", + "code":"31", + "des":"This API is used to query route propagations.Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (id, c", + "doc_type":"api", + "kw":"Querying Route Propagations,Propagations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Route Propagations", + "githuburl":"" + }, + { + "uri":"DisablePropagation.html", + "node_id":"disablepropagation.xml", + "product_code":"er", + "code":"32", + "des":"This API is used to delete a propagation from the route table of an enterprise router for an attachment.POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{rout", + "doc_type":"api", + "kw":"Deleting a Route Propagation,Propagations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting a Route Propagation", + "githuburl":"" + }, + { + "uri":"Route.html", + "node_id":"route.xml", + "product_code":"er", + "code":"33", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Routes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Routes", + "githuburl":"" + }, + { + "uri":"CreateStaticRoute.html", + "node_id":"createstaticroute.xml", + "product_code":"er", + "code":"34", + "des":"This API is used to create a static route. Static routes are manually created, and effective routes are preferred routes.If is_blackhole is set to false, the attachment_i", + "doc_type":"api", + "kw":"Creating a Static Route,Routes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating a Static Route", + "githuburl":"" + }, + { + "uri":"UpdateStaticRoute.html", + "node_id":"updatestaticroute.xml", + "product_code":"er", + "code":"35", + "des":"This API is used to update a static route.If is_blackhole is set to false, the attachment_id parameter must be carried. If is_blackhole is set to true, the attachment_id ", + "doc_type":"api", + "kw":"Updating a Static Route,Routes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Updating a Static Route", + "githuburl":"" + }, + { + "uri":"ShowStaticRoute.html", + "node_id":"showstaticroute.xml", + "product_code":"er", + "code":"36", + "des":"This API is used to query details about a static route.GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}NoneStatus code: 200St", + "doc_type":"api", + "kw":"Querying Details About a Static Route,Routes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Details About a Static Route", + "githuburl":"" + }, + { + "uri":"ListStaticRoutes.html", + "node_id":"liststaticroutes.xml", + "product_code":"er", + "code":"37", + "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":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Static Routes", + "githuburl":"" + }, + { + "uri":"ListEffectiveRoutes.html", + "node_id":"listeffectiveroutes.xml", + "product_code":"er", + "code":"38", + "des":"This API is used to query effective routes. Pagination query is supported. Effective routes are preferred routes.GET /v3/{project_id}/enterprise-router/route-tables/{rout", + "doc_type":"api", + "kw":"Querying Effective Routes,Routes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Effective Routes", + "githuburl":"" + }, + { + "uri":"DeleteStaticRoute.html", + "node_id":"deletestaticroute.xml", + "product_code":"er", + "code":"39", + "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.", + "doc_type":"api", + "kw":"Deleting a Static Route,Routes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting a Static Route", + "githuburl":"" + }, + { + "uri":"Tags.html", + "node_id":"tags.xml", + "product_code":"er", + "code":"40", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Tags", + "githuburl":"" + }, + { + "uri":"ListProjectTags.html", + "node_id":"listprojecttags.xml", + "product_code":"er", + "code":"41", + "des":"This API is used to query tags of resources of a specific type.GET /v3/{project_id}/{resource_type}/tagsNoneStatus code: 200Querying tags of an enterprise routerStatus co", + "doc_type":"api", + "kw":"Querying Project Tags,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Project Tags", + "githuburl":"" + }, + { + "uri":"ShowResourceTag.html", + "node_id":"showresourcetag.xml", + "product_code":"er", + "code":"42", + "des":"This API is used to query tags of resources of a specific type.GET /v3/{project_id}/{resource_type}/{resource_id}/tagsNoneStatus code: 200Querying tags of an enterprise r", + "doc_type":"api", + "kw":"Querying Resource Tags,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Resource Tags", + "githuburl":"" + }, + { + "uri":"CreateResourceTag.html", + "node_id":"createresourcetag.xml", + "product_code":"er", + "code":"43", + "des":"This API is used to create tags for resources of a specific type.A resource can have up to 20 tags.A resource can have up to 20 tags.This API is idempotent.This API is id", + "doc_type":"api", + "kw":"Creating Resource Tags,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating Resource Tags", + "githuburl":"" + }, + { + "uri":"DeleteResourceTag.html", + "node_id":"deleteresourcetag.xml", + "product_code":"er", + "code":"44", + "des":"This API is used to delete tags for resources of a specific type.This API is idempotent. The key cannot be left blank or be an empty string.DELETE /v3/{project_id}/{resou", + "doc_type":"api", + "kw":"Deleting Resource Tags,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting Resource Tags", + "githuburl":"" + }, + { + "uri":"QuotaManager.html", + "node_id":"quotamanager.xml", + "product_code":"er", + "code":"45", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Quota Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Quota Management", + "githuburl":"" + }, + { + "uri":"ShowQuotas.html", + "node_id":"showquotas.xml", + "product_code":"er", + "code":"46", + "des":"This API is used to query the used quotas of resources, such as enterprise routers and VPC attachments.GET /v3/{project_id}/enterprise-router/quotasNoneStatus code: 200Qu", + "doc_type":"api", + "kw":"Querying Quotas,Quota Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Quotas", + "githuburl":"" + }, + { + "uri":"AvailableZone.html", + "node_id":"availablezone.xml", + "product_code":"er", + "code":"47", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"AZs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"AZs", + "githuburl":"" + }, + { + "uri":"ListAvailabilityZone.html", + "node_id":"listavailabilityzone.xml", + "product_code":"er", + "code":"48", + "des":"This API is used to query AZs where enterprise routers can be created. An enterprise router can be created only when an AZ is in the available state.GET /v3/{project_id}/", + "doc_type":"api", + "kw":"Querying AZs,AZs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying AZs", + "githuburl":"" + }, + { + "uri":"FlowLog.html", + "node_id":"flowlog.xml", + "product_code":"er", + "code":"49", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Flow Logs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Flow Logs", + "githuburl":"" + }, + { + "uri":"CreateFlowLog.html", + "node_id":"createflowlog.xml", + "product_code":"er", + "code":"50", + "des":"This API is used to create a flow log for an enterprise router.POST /v3/{project_id}/enterprise-router/{er_id}/flow-logsStatus code: 202Creating a flow logStatus code: 20", + "doc_type":"api", + "kw":"Creating a Flow Log,Flow Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Creating a Flow Log", + "githuburl":"" + }, + { + "uri":"ListFlowLogs.html", + "node_id":"listflowlogs.xml", + "product_code":"er", + "code":"51", + "des":"This API is used to query the flow log list.Filtering query is supported. You can use resource_type, resource_id, and enterprise_project_id for query. You can query multi", + "doc_type":"api", + "kw":"Querying Flow Logs,Flow Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Flow Logs", + "githuburl":"" + }, + { + "uri":"ShowFlowLog.html", + "node_id":"showflowlog.xml", + "product_code":"er", + "code":"52", + "des":"This API is used to query details about a flow log.GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}NoneStatus code: 200Querying flow logsStatus code", + "doc_type":"api", + "kw":"Querying Details About a Flow Log,Flow Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Querying Details About a Flow Log", + "githuburl":"" + }, + { + "uri":"UpdateFlowLog.html", + "node_id":"updateflowlog.xml", + "product_code":"er", + "code":"53", + "des":"This API is used to update a flow log.PUT /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}Status code: 200Updating a flow logStatus code: 200OKSee Error", + "doc_type":"api", + "kw":"Updating a Flow Log,Flow Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Updating a Flow Log", + "githuburl":"" + }, + { + "uri":"DeleteFlowLog.html", + "node_id":"deleteflowlog.xml", + "product_code":"er", + "code":"54", + "des":"This API is used to delete a flow log.A flow log can be deleted only when it is in the available, deleting, or failed state.DELETE /v3/{project_id}/enterprise-router/{er_", + "doc_type":"api", + "kw":"Deleting a Flow Log,Flow Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Deleting a Flow Log", + "githuburl":"" + }, + { + "uri":"EnableFlowLog.html", + "node_id":"enableflowlog.xml", + "product_code":"er", + "code":"55", + "des":"This API is used to enable flow logs.POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/enableNoneStatus code: 202Enabling flow logsStatus code: 202A", + "doc_type":"api", + "kw":"Enabling Flow Logs,Flow Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Enabling Flow Logs", + "githuburl":"" + }, + { + "uri":"DisableFlowLog.html", + "node_id":"disableflowlog.xml", + "product_code":"er", + "code":"56", + "des":"This API is used to disable flow logs.POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/disableNoneStatus code: 202Disabling flow logsStatus code: 2", + "doc_type":"api", + "kw":"Disabling Flow Logs,Flow Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "operation_id":"UpdateVpcAttachment", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Disabling Flow Logs", + "githuburl":"" + }, + { + "uri":"er_02_0035.html", + "node_id":"er_02_0035.xml", + "product_code":"er", + "code":"57", + "des":"You can share an enterprise router in your account with other accounts.You are the owner of the enterprise router.Other accounts are the users of the enterprise router.Yo", + "doc_type":"api", + "kw":"Sharing,APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Sharing", + "githuburl":"" + }, + { + "uri":"er_02_0015.html", + "node_id":"er_02_0015.xml", + "product_code":"er", + "code":"58", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Permissions Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"er_02_0016.html", + "node_id":"er_02_0016.xml", + "product_code":"er", + "code":"59", + "des":"This section describes fine-grained permissions management for your Enterprise Router resources. If your account does not need individual IAM users, you may skip this sec", + "doc_type":"api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"er_02_0017.html", + "node_id":"er_02_0017.xml", + "product_code":"er", + "code":"60", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Enterprise Routers,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Enterprise Routers", + "githuburl":"" + }, + { + "uri":"er_02_0018.html", + "node_id":"er_02_0018.xml", + "product_code":"er", + "code":"61", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPC Attachments,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"VPC Attachments", + "githuburl":"" + }, + { + "uri":"er_02_0019.html", + "node_id":"er_02_0019.xml", + "product_code":"er", + "code":"62", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Attachments,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Attachments", + "githuburl":"" + }, + { + "uri":"er_02_0020.html", + "node_id":"er_02_0020.xml", + "product_code":"er", + "code":"63", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Route Tables,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Route Tables", + "githuburl":"" + }, + { + "uri":"er_02_0021.html", + "node_id":"er_02_0021.xml", + "product_code":"er", + "code":"64", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Associations,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Associations", + "githuburl":"" + }, + { + "uri":"er_02_0022.html", + "node_id":"er_02_0022.xml", + "product_code":"er", + "code":"65", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Propagations,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Propagations", + "githuburl":"" + }, + { + "uri":"er_02_0023.html", + "node_id":"er_02_0023.xml", + "product_code":"er", + "code":"66", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Routes,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Routes", + "githuburl":"" + }, + { + "uri":"er_02_0024.html", + "node_id":"er_02_0024.xml", + "product_code":"er", + "code":"67", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Flow Logs,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Flow Logs", + "githuburl":"" + }, + { + "uri":"er_02_0033.html", + "node_id":"er_02_0033.xml", + "product_code":"er", + "code":"68", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Tags,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Tags", + "githuburl":"" + }, + { + "uri":"er_02_0034.html", + "node_id":"er_02_0034.xml", + "product_code":"er", + "code":"69", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Quota Management,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Quota Management", + "githuburl":"" + }, + { + "uri":"er_02_appendix.html", + "node_id":"er_02_appendix.xml", + "product_code":"er", + "code":"70", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Appendixes", + "githuburl":"" + }, + { + "uri":"StateCode.html", + "node_id":"statecode.xml", + "product_code":"er", + "code":"71", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Status Codes,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"ErrorCode.html", + "node_id":"errorcode_1.xml", + "product_code":"er", + "code":"72", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Error Codes,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"APIChangeHistory.html", + "node_id":"apichangehistory.xml", + "product_code":"er", + "code":"73", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"er", + "opensource":"true" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/er/api-ref/APIChangeHistory.html b/docs/er/api-ref/APIChangeHistory.html new file mode 100644 index 000000000..9f9f605d7 --- /dev/null +++ b/docs/er/api-ref/APIChangeHistory.html @@ -0,0 +1,50 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + +

Released On

+

Description

+

2023-12-06

+

This release incorporates the following changes:

+
  • Modified the descriptions of the tag key and value in the document.
  • Modified the description of the status code in "Querying AZs."
+

2023-11-17

+

This release incorporates the following changes:

+
  • Added section "Sharing" to state that this function cannot be used through APIs.
  • Added section "Permissions and Supported Actions" to describe enterprise router permissions.
+

2023-11-01

+

This release incorporates the following changes:

+
  • Modified the name parameter in "Creating an Enterprise Router", "Creating a Route Table", and "Updating Route Table Information".
  • Modified the descriptions of the tag key and value in the document.
  • Deleted the owned_by_self parameter from "Querying Enterprise Routers".
  • Modified the description of status code 202 in "Deleting an Enterprise Router", "Deleting a Static Route", and "Querying Quotas".
  • Added constraints in "Updating a Static Route".
+

2023-10-09

+

This release incorporates the following changes:

+
  • Added the description of attachments in "API Usage Guidelines".
  • Modified the descriptions of parameters created_at and updated_at to add the time format.
  • Modified the description of the state parameter to add numerated values.
  • Added the charge_mode parameter in "Creating an Enterprise Router".
  • Added a description that the route_policy parameter is not supported in "Creating a Route Association".
  • Modified the description of the resource_type parameter in "Creating a Route Association" and "Creating a Route Propagation".
+

2023-09-22

+

This release incorporates the following changes:

+
  • Modified the description of the state parameter in "Creating an Enterprise Router", "Updating an Enterprise Router", and "Querying Details About an Enterprise Router".
  • Modified the example response in "Querying VPC Attachments".
  • Modified the description of the type parameter in "Creating a Static Route".
  • Modified the description of the route_type parameter in "Querying Effective Routes".
+

2023-04-07

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/er/api-ref/AssociateRouteTable.html b/docs/er/api-ref/AssociateRouteTable.html new file mode 100644 index 000000000..4c695af32 --- /dev/null +++ b/docs/er/api-ref/AssociateRouteTable.html @@ -0,0 +1,332 @@ + + +

Creating a Route Association

+

Function

This API is used to create a route association. Each attachment only can be associated with one route table of its enterprise router for packet forwarding.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associate

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Client-Token

+

No

+

String

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

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

Parameter

+

Mandatory

+

Type

+

Description

+

attachment_id

+

No

+

String

+

Unique ID of the attachment

+

Maximum: 36

+

route_policy

+

No

+

ExportRoutePolicy object

+

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

+
+
+ +
+ + + + + + + + + + + +
Table 4 ExportRoutePolicy

Parameter

+

Mandatory

+

Type

+

Description

+

export_policy_id

+

No

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 5 Response header parameters

Parameter

+

Type

+

Description

+

X-Client-Token

+

-

+

Idempotence identifier

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

Parameter

+

Type

+

Description

+

association

+

Association object

+

Association details

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Unique association ID

+

Maximum: 36

+

route_table_id

+

String

+

Unique ID of the route table

+

Maximum: 36

+

attachment_id

+

String

+

Unique ID of the attachment

+

Maximum: 36

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

resource_id

+

String

+

Unique ID of the attachment

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

route_policy

+

ExportRoutePolicy object

+

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

+
+
+ +
+ + + + + + + + + +
Table 8 ExportRoutePolicy

Parameter

+

Type

+

Description

+

export_policy_id

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+
+

Example Requests

Creating a route table association

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f8/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/associate
+
+{
+  "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64"
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "association" : {
+    "id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
+    "route_table_id" : "91c013e2-d65a-474e-9177-c3e1799ca726",
+    "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64",
+    "resource_type" : "vpc",
+    "resource_id" : "4e5fe97c-82bc-432e-87d8-06d7e157dffa",
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31",
+    "updated_at" : "2020-03-11T15:13:31",
+    "route_policy" : {
+      "export_policy_id" : ""
+    }
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f8"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Associations
+
+
+ diff --git a/docs/er/api-ref/Association.html b/docs/er/api-ref/Association.html new file mode 100644 index 000000000..6130c3adc --- /dev/null +++ b/docs/er/api-ref/Association.html @@ -0,0 +1,20 @@ + + +

Associations

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/Attachments.html b/docs/er/api-ref/Attachments.html new file mode 100644 index 000000000..4356846f1 --- /dev/null +++ b/docs/er/api-ref/Attachments.html @@ -0,0 +1,20 @@ + + +

Attachments

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/AvailableZone.html b/docs/er/api-ref/AvailableZone.html new file mode 100644 index 000000000..8329d8c5f --- /dev/null +++ b/docs/er/api-ref/AvailableZone.html @@ -0,0 +1,16 @@ + + +

AZs

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/CLASS.TXT.json b/docs/er/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..99d22c57b --- /dev/null +++ b/docs/er/api-ref/CLASS.TXT.json @@ -0,0 +1,659 @@ +[ + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"er", + "title":"API Usage Guidelines", + "uri":"er_02_0001.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"APIs", + "uri":"er_02_0014.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Enterprise Routers", + "uri":"EnterpriseRouterInstance.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API is used to create an enterprise router. If both Default Route Table Association and Default Route Table Propagation are enabled, the system will create a route t", + "product_code":"er", + "title":"Creating an Enterprise Router", + "uri":"CreateEnterpriseRouter.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to update basic information about the enterprise router.Information (except name and description) can be updated only when the enterprise router is in th", + "product_code":"er", + "title":"Updating an Enterprise Router", + "uri":"UpdateEnterpriseRouter.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "desc":"This API is used to query details about an enterprise router.GET /v3/{project_id}/enterprise-router/instances/{er_id}NoneStatus code: 200Querying details about an enterpr", + "product_code":"er", + "title":"Querying Details About an Enterprise Router", + "uri":"ShowEnterpriseRouter.html", + "doc_type":"api", + "p_code":"3", + "code":"6" + }, + { + "desc":"This API is used to query enterprise routers.Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together. O", + "product_code":"er", + "title":"Querying Enterprise Routers", + "uri":"ListEnterpriseRouters.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This API is used to delete an enterprise router.DELETE /v3/{project_id}/enterprise-router/instances/{er_id}NoneNoneDeleting an enterprise routerNoneSee Error Codes.", + "product_code":"er", + "title":"Deleting an Enterprise Router", + "uri":"DeleteEnterpriseRouter.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"VPC Attachments", + "uri":"VPCAttachment.html", + "doc_type":"api", + "p_code":"2", + "code":"9" + }, + { + "desc":"This API is used to create a VPC attachment for an enterprise router.POST /v3/{project_id}/enterprise-router/{er_id}/vpc-attachmentsStatus code: 202Creating a VPC attachm", + "product_code":"er", + "title":"Creating a VPC Attachment", + "uri":"CreateVpcAttachment.html", + "doc_type":"api", + "p_code":"9", + "code":"10" + }, + { + "desc":"This API is used to update basic information about a VPC attachment.PUT /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}Status code: 200Upda", + "product_code":"er", + "title":"Updating a VPC Attachment", + "uri":"UpdateVpcAttachment.html", + "doc_type":"api", + "p_code":"9", + "code":"11" + }, + { + "desc":"This API is used to query details about a VPC attachment.GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}NoneStatus code: 200Querying de", + "product_code":"er", + "title":"Querying Details About a VPC Attachment", + "uri":"ShowVpcAttachment.html", + "doc_type":"api", + "p_code":"9", + "code":"12" + }, + { + "desc":"This API is used to query the VPC attachments of the enterprise router.VPC attachments can be queried in the following methods:Filtering query is supported. You can query", + "product_code":"er", + "title":"Querying VPC Attachments", + "uri":"ListVpcAttachments.html", + "doc_type":"api", + "p_code":"9", + "code":"13" + }, + { + "desc":"This API is used to delete a VPC attachment.A VPC attachment can be deleted only when it is in the available, deleting, or failed state.DELETE /v3/{project_id}/enterprise", + "product_code":"er", + "title":"Deleting a VPC Attachment", + "uri":"DeleteVpcAttachment.html", + "doc_type":"api", + "p_code":"9", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Attachments", + "uri":"Attachments.html", + "doc_type":"api", + "p_code":"2", + "code":"15" + }, + { + "desc":"This API is used to update basic information about an attachment.PUT /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}Status code: 200Updating an att", + "product_code":"er", + "title":"Updating an Attachment", + "uri":"UpdateAttachment.html", + "doc_type":"api", + "p_code":"15", + "code":"16" + }, + { + "desc":"This API is used to query details about an attachment.GET /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}NoneStatus code: 200Querying details about", + "product_code":"er", + "title":"Querying Details About an Attachment", + "uri":"ShowAttachment.html", + "doc_type":"api", + "p_code":"15", + "code":"17" + }, + { + "desc":"This API is used to query the attachments of the enterprise router.Filtering query is supported. The filtering criteria include state, resource_type, and resource_id. You", + "product_code":"er", + "title":"Querying Attachments", + "uri":"ListAttachments.html", + "doc_type":"api", + "p_code":"15", + "code":"18" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Route Tables", + "uri":"RouteTable.html", + "doc_type":"api", + "p_code":"2", + "code":"19" + }, + { + "desc":"This API is used to create a route table. A route table is the basis for an enterprise router to send and receive packets. It contains attachment associations, propagatio", + "product_code":"er", + "title":"Creating a Route Table", + "uri":"CreateRouteTable.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "desc":"This API is used to update basic information about a route table, such as the name and description.PUT /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_tabl", + "product_code":"er", + "title":"Updating Route Table Information", + "uri":"UpdateRouteTable.html", + "doc_type":"api", + "p_code":"19", + "code":"21" + }, + { + "desc":"This API is used to query details about a route table.GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}NoneStatus code: 200Querying details abo", + "product_code":"er", + "title":"Querying Details About a Route Table", + "uri":"ShowRouteTable.html", + "doc_type":"api", + "p_code":"19", + "code":"22" + }, + { + "desc":"This API is used to query route tables.Pagination query is supported. The supported query criteria are state, is_default_propagation_route_table, and is_default_associati", + "product_code":"er", + "title":"Querying Route Tables", + "uri":"ListRouteTables.html", + "doc_type":"api", + "p_code":"19", + "code":"23" + }, + { + "desc":"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.", + "product_code":"er", + "title":"Deleting a Route Table", + "uri":"DeleteRouteTable.html", + "doc_type":"api", + "p_code":"19", + "code":"24" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Associations", + "uri":"Association.html", + "doc_type":"api", + "p_code":"2", + "code":"25" + }, + { + "desc":"This API is used to create a route association. Each attachment only can be associated with one route table of its enterprise router for packet forwarding.POST /v3/{proje", + "product_code":"er", + "title":"Creating a Route Association", + "uri":"AssociateRouteTable.html", + "doc_type":"api", + "p_code":"25", + "code":"26" + }, + { + "desc":"This API is used to query route associations.Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (id, c", + "product_code":"er", + "title":"Querying Route Associations", + "uri":"ListAssociations.html", + "doc_type":"api", + "p_code":"25", + "code":"27" + }, + { + "desc":"This API is used to delete an association from the route table of an enterprise router for an attachment.POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{rou", + "product_code":"er", + "title":"Deleting a Route Association", + "uri":"DisassociateRouteTable.html", + "doc_type":"api", + "p_code":"25", + "code":"28" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Propagations", + "uri":"Propagation.html", + "doc_type":"api", + "p_code":"2", + "code":"29" + }, + { + "desc":"This API is used to create a route propagation. A propagation can be created for each attachment to propagate routes to one or more route tables on an enterprise router.P", + "product_code":"er", + "title":"Creating a Route Propagation", + "uri":"EnablePropagation.html", + "doc_type":"api", + "p_code":"29", + "code":"30" + }, + { + "desc":"This API is used to query route propagations.Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (id, c", + "product_code":"er", + "title":"Querying Route Propagations", + "uri":"ListPropagations.html", + "doc_type":"api", + "p_code":"29", + "code":"31" + }, + { + "desc":"This API is used to delete a propagation from the route table of an enterprise router for an attachment.POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{rout", + "product_code":"er", + "title":"Deleting a Route Propagation", + "uri":"DisablePropagation.html", + "doc_type":"api", + "p_code":"29", + "code":"32" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Routes", + "uri":"Route.html", + "doc_type":"api", + "p_code":"2", + "code":"33" + }, + { + "desc":"This API is used to create a static route. Static routes are manually created, and effective routes are preferred routes.If is_blackhole is set to false, the attachment_i", + "product_code":"er", + "title":"Creating a Static Route", + "uri":"CreateStaticRoute.html", + "doc_type":"api", + "p_code":"33", + "code":"34" + }, + { + "desc":"This API is used to update a static route.If is_blackhole is set to false, the attachment_id parameter must be carried. If is_blackhole is set to true, the attachment_id ", + "product_code":"er", + "title":"Updating a Static Route", + "uri":"UpdateStaticRoute.html", + "doc_type":"api", + "p_code":"33", + "code":"35" + }, + { + "desc":"This API is used to query details about a static route.GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}NoneStatus code: 200St", + "product_code":"er", + "title":"Querying Details About a Static Route", + "uri":"ShowStaticRoute.html", + "doc_type":"api", + "p_code":"33", + "code":"36" + }, + { + "desc":"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", + "product_code":"er", + "title":"Querying Static Routes", + "uri":"ListStaticRoutes.html", + "doc_type":"api", + "p_code":"33", + "code":"37" + }, + { + "desc":"This API is used to query effective routes. Pagination query is supported. Effective routes are preferred routes.GET /v3/{project_id}/enterprise-router/route-tables/{rout", + "product_code":"er", + "title":"Querying Effective Routes", + "uri":"ListEffectiveRoutes.html", + "doc_type":"api", + "p_code":"33", + "code":"38" + }, + { + "desc":"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.", + "product_code":"er", + "title":"Deleting a Static Route", + "uri":"DeleteStaticRoute.html", + "doc_type":"api", + "p_code":"33", + "code":"39" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Tags", + "uri":"Tags.html", + "doc_type":"api", + "p_code":"2", + "code":"40" + }, + { + "desc":"This API is used to query tags of resources of a specific type.GET /v3/{project_id}/{resource_type}/tagsNoneStatus code: 200Querying tags of an enterprise routerStatus co", + "product_code":"er", + "title":"Querying Project Tags", + "uri":"ListProjectTags.html", + "doc_type":"api", + "p_code":"40", + "code":"41" + }, + { + "desc":"This API is used to query tags of resources of a specific type.GET /v3/{project_id}/{resource_type}/{resource_id}/tagsNoneStatus code: 200Querying tags of an enterprise r", + "product_code":"er", + "title":"Querying Resource Tags", + "uri":"ShowResourceTag.html", + "doc_type":"api", + "p_code":"40", + "code":"42" + }, + { + "desc":"This API is used to create tags for resources of a specific type.A resource can have up to 20 tags.A resource can have up to 20 tags.This API is idempotent.This API is id", + "product_code":"er", + "title":"Creating Resource Tags", + "uri":"CreateResourceTag.html", + "doc_type":"api", + "p_code":"40", + "code":"43" + }, + { + "desc":"This API is used to delete tags for resources of a specific type.This API is idempotent. The key cannot be left blank or be an empty string.DELETE /v3/{project_id}/{resou", + "product_code":"er", + "title":"Deleting Resource Tags", + "uri":"DeleteResourceTag.html", + "doc_type":"api", + "p_code":"40", + "code":"44" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Quota Management", + "uri":"QuotaManager.html", + "doc_type":"api", + "p_code":"2", + "code":"45" + }, + { + "desc":"This API is used to query the used quotas of resources, such as enterprise routers and VPC attachments.GET /v3/{project_id}/enterprise-router/quotasNoneStatus code: 200Qu", + "product_code":"er", + "title":"Querying Quotas", + "uri":"ShowQuotas.html", + "doc_type":"api", + "p_code":"45", + "code":"46" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"AZs", + "uri":"AvailableZone.html", + "doc_type":"api", + "p_code":"2", + "code":"47" + }, + { + "desc":"This API is used to query AZs where enterprise routers can be created. An enterprise router can be created only when an AZ is in the available state.GET /v3/{project_id}/", + "product_code":"er", + "title":"Querying AZs", + "uri":"ListAvailabilityZone.html", + "doc_type":"api", + "p_code":"47", + "code":"48" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Flow Logs", + "uri":"FlowLog.html", + "doc_type":"api", + "p_code":"2", + "code":"49" + }, + { + "desc":"This API is used to create a flow log for an enterprise router.POST /v3/{project_id}/enterprise-router/{er_id}/flow-logsStatus code: 202Creating a flow logStatus code: 20", + "product_code":"er", + "title":"Creating a Flow Log", + "uri":"CreateFlowLog.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "desc":"This API is used to query the flow log list.Filtering query is supported. You can use resource_type, resource_id, and enterprise_project_id for query. You can query multi", + "product_code":"er", + "title":"Querying Flow Logs", + "uri":"ListFlowLogs.html", + "doc_type":"api", + "p_code":"49", + "code":"51" + }, + { + "desc":"This API is used to query details about a flow log.GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}NoneStatus code: 200Querying flow logsStatus code", + "product_code":"er", + "title":"Querying Details About a Flow Log", + "uri":"ShowFlowLog.html", + "doc_type":"api", + "p_code":"49", + "code":"52" + }, + { + "desc":"This API is used to update a flow log.PUT /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}Status code: 200Updating a flow logStatus code: 200OKSee Error", + "product_code":"er", + "title":"Updating a Flow Log", + "uri":"UpdateFlowLog.html", + "doc_type":"api", + "p_code":"49", + "code":"53" + }, + { + "desc":"This API is used to delete a flow log.A flow log can be deleted only when it is in the available, deleting, or failed state.DELETE /v3/{project_id}/enterprise-router/{er_", + "product_code":"er", + "title":"Deleting a Flow Log", + "uri":"DeleteFlowLog.html", + "doc_type":"api", + "p_code":"49", + "code":"54" + }, + { + "desc":"This API is used to enable flow logs.POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/enableNoneStatus code: 202Enabling flow logsStatus code: 202A", + "product_code":"er", + "title":"Enabling Flow Logs", + "uri":"EnableFlowLog.html", + "doc_type":"api", + "p_code":"49", + "code":"55" + }, + { + "desc":"This API is used to disable flow logs.POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/disableNoneStatus code: 202Disabling flow logsStatus code: 2", + "product_code":"er", + "title":"Disabling Flow Logs", + "uri":"DisableFlowLog.html", + "doc_type":"api", + "p_code":"49", + "code":"56" + }, + { + "desc":"You can share an enterprise router in your account with other accounts.You are the owner of the enterprise router.Other accounts are the users of the enterprise router.Yo", + "product_code":"er", + "title":"Sharing", + "uri":"er_02_0035.html", + "doc_type":"api", + "p_code":"2", + "code":"57" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Permissions Policies and Supported Actions", + "uri":"er_02_0015.html", + "doc_type":"api", + "p_code":"", + "code":"58" + }, + { + "desc":"This section describes fine-grained permissions management for your Enterprise Router resources. If your account does not need individual IAM users, you may skip this sec", + "product_code":"er", + "title":"Introduction", + "uri":"er_02_0016.html", + "doc_type":"api", + "p_code":"58", + "code":"59" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Enterprise Routers", + "uri":"er_02_0017.html", + "doc_type":"api", + "p_code":"58", + "code":"60" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"VPC Attachments", + "uri":"er_02_0018.html", + "doc_type":"api", + "p_code":"58", + "code":"61" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Attachments", + "uri":"er_02_0019.html", + "doc_type":"api", + "p_code":"58", + "code":"62" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Route Tables", + "uri":"er_02_0020.html", + "doc_type":"api", + "p_code":"58", + "code":"63" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Associations", + "uri":"er_02_0021.html", + "doc_type":"api", + "p_code":"58", + "code":"64" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Propagations", + "uri":"er_02_0022.html", + "doc_type":"api", + "p_code":"58", + "code":"65" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Routes", + "uri":"er_02_0023.html", + "doc_type":"api", + "p_code":"58", + "code":"66" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Flow Logs", + "uri":"er_02_0024.html", + "doc_type":"api", + "p_code":"58", + "code":"67" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Tags", + "uri":"er_02_0033.html", + "doc_type":"api", + "p_code":"58", + "code":"68" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Quota Management", + "uri":"er_02_0034.html", + "doc_type":"api", + "p_code":"58", + "code":"69" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Appendixes", + "uri":"er_02_appendix.html", + "doc_type":"api", + "p_code":"", + "code":"70" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Status Codes", + "uri":"StateCode.html", + "doc_type":"api", + "p_code":"70", + "code":"71" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Error Codes", + "uri":"ErrorCode.html", + "doc_type":"api", + "p_code":"70", + "code":"72" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"er", + "title":"Change History", + "uri":"APIChangeHistory.html", + "doc_type":"api", + "p_code":"", + "code":"73" + } +] \ No newline at end of file diff --git a/docs/er/api-ref/CreateEnterpriseRouter.html b/docs/er/api-ref/CreateEnterpriseRouter.html new file mode 100644 index 000000000..286f1ee35 --- /dev/null +++ b/docs/er/api-ref/CreateEnterpriseRouter.html @@ -0,0 +1,524 @@ + + +

Creating an Enterprise Router

+

Function

This API is used to create an enterprise router. If both Default Route Table Association and Default Route Table Propagation are enabled, the system will create a route table as both the default association route table and the default propagation route table.

+
+

URI

POST /v3/{project_id}/enterprise-router/instances

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Client-Token

+

No

+

String

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance

+

Yes

+

CreateEnterpriseRouter object

+

Enterprise router

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreateEnterpriseRouter

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Enterprise router name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Supplementary information about an enterprise router

+

Minimum: 0

+

Maximum: 255

+

asn

+

Yes

+

Long

+

Enterprise router BGP ASN

+

enterprise_project_id

+

No

+

String

+

Enterprise project ID

+

charge_mode

+

No

+

String

+

Default: postPaid

+

tags

+

No

+

Array of Tag objects

+

Tag information

+

enable_default_propagation

+

No

+

Boolean

+

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

+

Default: false

+

enable_default_association

+

No

+

Boolean

+

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

+

Default: false

+

availability_zone_ids

+

Yes

+

Array of strings

+

AZs where the enterprise router is located

+

Minimum: 0

+

Maximum: 128

+

auto_accept_shared_attachments

+

No

+

Boolean

+

Whether to enable Auto Accept Shared Attachments. The default value is false, indicating that the function is disabled.

+

Default: false

+

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

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

+

value

+

No

+

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

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 6 Response header parameters

Parameter

+

Type

+

Description

+

X-Client-Token

+

-

+

Idempotence identifier

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

Parameter

+

Type

+

Description

+

instance

+

EnterpriseRouter object

+

Enterprise router

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Enterprise router ID

+

name

+

String

+

Enterprise router name

+

description

+

String

+

Supplementary information about an enterprise router

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

charge_mode

+

String

+

Default: postPaid

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

enterprise_project_id

+

String

+

Enterprise project ID

+

project_id

+

String

+

Project ID

+

asn

+

Long

+

Enterprise router BGP ASN

+

enable_default_propagation

+

Boolean

+

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

+

enable_default_association

+

Boolean

+

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

+

default_propagation_route_table_id

+

String

+

Default propagation route table ID

+

default_association_route_table_id

+

String

+

Default association route table ID

+

availability_zone_ids

+

Array of strings

+

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

+

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

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Creating an enterprise router

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances
+
+{
+  "instance" : {
+    "name" : "my_er",
+    "description" : "this is my first enterprise router",
+    "asn" : 64512,
+    "enable_default_association" : true,
+    "enable_default_propagation" : true,
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "availability_zone_ids" : [ "az1", "az2" ]
+  }
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "instance" : {
+    "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
+    "name" : "my_er",
+    "description" : "this is my first enterprise router",
+    "asn" : 64512,
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "enable_default_association" : true,
+    "enable_default_propagation" : true,
+    "default_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
+    "default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
+    "auto_accept_shared_attachments" : false,
+    "created_at" : "2019-09-06 02:11:13Z",
+    "updated_at" : "2019-09-06 02:11:13Z",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    } ],
+    "enterprise_project_id" : 0,
+    "availability_zone_ids" : [ "az1", "az2" ]
+  },
+  "request_id" : "14c2b814-99dc-939a-e811-ae84c61ea3f4"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Enterprise Routers
+
+
+ diff --git a/docs/er/api-ref/CreateFlowLog.html b/docs/er/api-ref/CreateFlowLog.html new file mode 100644 index 000000000..bcf894bb2 --- /dev/null +++ b/docs/er/api-ref/CreateFlowLog.html @@ -0,0 +1,410 @@ + + +

Creating a Flow Log

+

Function

This API is used to create a flow log for an enterprise router.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Client-Token

+

No

+

String

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

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

Parameter

+

Mandatory

+

Type

+

Description

+

flow_log

+

Yes

+

FlowLogRequest object

+

Request body for creating a flow log

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 FlowLogRequest

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Flow log name

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Flow log description

+

Minimum: 0

+

Maximum: 255

+

resource_type

+

Yes

+

String

+

Type of resource whose flow logs are collected.

+

  • VPC attachments

    +

  • Virtual gateway attachments

    +
+

resource_id

+

Yes

+

String

+

Resource ID

+

log_group_id

+

Yes

+

String

+

Log group ID. Obtain the log group ID by referring to the Log Tank Service User Guide.

+

log_stream_id

+

Yes

+

String

+

Log stream ID. Obtain the log stream ID by referring to the Log Tank Service User Guide.

+

log_store_type

+

Yes

+

String

+

Flow log storage type.

+

LTS: Logs are stored on LTS servers.

+

log_store_name

+

No

+

String

+

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

+

Minimum: 1

+

Maximum: 255

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 5 Response header parameters

Parameter

+

Type

+

Description

+

X-Client-Token

+

-

+

Idempotence identifier

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

Parameter

+

Type

+

Description

+

flow_log

+

FlowLog object

+

Flow log details

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 FlowLog

Parameter

+

Type

+

Description

+

id

+

String

+

Flow log ID

+

name

+

String

+

Flow log name

+

description

+

String

+

Flow log description

+

project_id

+

String

+

Project ID of the flow log task creator

+

resource_type

+

String

+

Resource type. The value is attachment.

+

resource_id

+

String

+

Resource ID

+

log_group_id

+

String

+

Log group ID

+

log_stream_id

+

String

+

Log stream ID

+

log_store_type

+

String

+

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

+

log_store_name

+

String

+

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

+

log_aggregation_interval

+

Integer

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

state

+

String

+

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

+

enabled

+

Boolean

+

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

+
+
+
+

Example Requests

Creating a flow log

+
POST https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs
+
+{
+  "flow_log" : {
+    "name" : "flow-log",
+    "description" : "flow log test",
+    "resource_type" : "attachment",
+    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
+    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
+    "log_store_type" : "LTS"
+  }
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "flow_log" : {
+    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
+    "name" : "flow_log",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "resource_type" : "attachment",
+    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
+    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
+    "log_store_type" : "LTS",
+    "log_aggregation_interval" : 600,
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2022-03-11T15:13:31Z",
+    "state" : "available",
+    "enabled" : true,
+    "description" : "Flow Logs"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Flow Logs
+
+
+ diff --git a/docs/er/api-ref/CreateResourceTag.html b/docs/er/api-ref/CreateResourceTag.html new file mode 100644 index 000000000..0406f47b8 --- /dev/null +++ b/docs/er/api-ref/CreateResourceTag.html @@ -0,0 +1,157 @@ + + +

Creating Resource Tags

+

Function

This API is used to create tags for resources of a specific type.

+
+

Constraints

+
+

URI

POST /v3/{project_id}/{resource_type}/{resource_id}/tags

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

resource_id

+

Yes

+

String

+

Resource ID

+

resource_type

+

Yes

+

String

+

Resource type.

+

  • instance: enterprise router

    +

  • route-table: route table

    +

  • vpc-attachment: VPC attachment

    +

  • vgw-attachment: virtual gateway attachment

    +
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

tag

+

Yes

+

Tag object

+

Resource tag

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

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

+

value

+

No

+

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

+
+
+
+

Response Parameters

None

+
+

Example Requests

Creating tags for a resource

+
POST https://{erouter-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags
+
+{
+  "tag" : {
+    "key" : "key1",
+    "value" : "value1"
+  }
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

No Content

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tags
+
+
+ diff --git a/docs/er/api-ref/CreateRouteTable.html b/docs/er/api-ref/CreateRouteTable.html new file mode 100644 index 000000000..b695c31fa --- /dev/null +++ b/docs/er/api-ref/CreateRouteTable.html @@ -0,0 +1,453 @@ + + +

Creating a Route Table

+

Function

This API is used to create a route table. A route table is the basis for an enterprise router to send and receive packets. It contains attachment associations, propagations, and routes.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Client-Token

+

No

+

String

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

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

Parameter

+

Mandatory

+

Type

+

Description

+

route_table

+

No

+

CreateRouteTable object

+

Route table

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 CreateRouteTable

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Route table name.The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Supplementary information about the route table

+

Minimum: 0

+

Maximum: 255

+

bgp_options

+

No

+

BgpOptions object

+

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

+

tags

+

No

+

Array of Tag objects

+

Tag information

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 BgpOptions

Parameter

+

Mandatory

+

Type

+

Description

+

load_balancing_as_path_ignore

+

No

+

Boolean

+

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

+

No

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

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

+

value

+

No

+

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

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 7 Response header parameters

Parameter

+

Type

+

Description

+

X-Client-Token

+

-

+

Idempotence identifier

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

Parameter

+

Type

+

Description

+

route_table

+

RouteTable object

+

Route table

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Route table ID

+

name

+

String

+

Route table name

+

description

+

String

+

Supplementary information

+

is_default_association

+

Boolean

+

Whether the route table is the default association route table.

+

Default: false

+

is_default_propagation

+

Boolean

+

Whether the route table is the default propagation route table.

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag

+

bgp_options

+

BgpOptions object

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 BgpOptions

Parameter

+

Type

+

Description

+

load_balancing_as_path_ignore

+

Boolean

+

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

+

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.

+
+
+
+

Example Requests

Creating a route table

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f0/route-tables
+
+{
+  "route_table" : {
+    "name" : "my-route-table",
+    "tags" : [ {
+      "key" : "key",
+      "value" : "value"
+    } ]
+  }
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "route_table" : {
+    "id" : "4ab54142-7c92-48ad-8288-77727a231052",
+    "name" : "my-route-table",
+    "is_default_association" : false,
+    "is_default_propagation" : false,
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z",
+    "tags" : [ {
+      "key" : "key",
+      "value" : "value"
+    } ]
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Route Tables
+
+
+ diff --git a/docs/er/api-ref/CreateStaticRoute.html b/docs/er/api-ref/CreateStaticRoute.html new file mode 100644 index 000000000..a7c52857c --- /dev/null +++ b/docs/er/api-ref/CreateStaticRoute.html @@ -0,0 +1,348 @@ + + +

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.

+
+

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Client-Token

+

No

+

String

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

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

Parameter

+

Mandatory

+

Type

+

Description

+

route

+

Yes

+

CreateRoute object

+

Request body for creating a route

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

Parameter

+

Mandatory

+

Type

+

Description

+

destination

+

Yes

+

String

+

Destination address of the route

+

Minimum: 0

+

Maximum: 256

+

attachment_id

+

No

+

String

+

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

+

is_blackhole

+

No

+

Boolean

+

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

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 5 Response header parameters

Parameter

+

Type

+

Description

+

X-Client-Token

+

-

+

Idempotence identifier

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

Parameter

+

Type

+

Description

+

route

+

Route object

+

Route

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Route ID

+

type

+

String

+

Route type. The value is static.

+

state

+

String

+

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

+

is_blackhole

+

Boolean

+

Whether the route is a blackhole route

+

destination

+

String

+

Destination address of the route

+

attachments

+

Array of RouteAttachment objects

+

Next hops

+

route_table_id

+

String

+

Route table ID

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

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

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Attached resource ID

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

attachment_id

+

String

+

Attachment ID

+
+
+
+

Example Requests

Creating a static route

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/0d1748a0-5188-11e5-b86f-a51b5f125b84/static-routes
+
+{
+  "route" : {
+    "destination" : "192.168.0.0/16",
+    "is_blackhole" : false,
+    "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
+  }
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "route" : {
+    "id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
+    "type" : "static",
+    "destination" : "192.168.0.0/16",
+    "attachments" : [ {
+      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
+      "resource_type" : "vpc",
+      "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
+    } ],
+    "route_table_id" : "0d1748a0-5188-11e5-b86f-a51b5f125b84",
+    "is_blackhole" : false,
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Routes
+
+
+ diff --git a/docs/er/api-ref/CreateVpcAttachment.html b/docs/er/api-ref/CreateVpcAttachment.html new file mode 100644 index 000000000..a490b3878 --- /dev/null +++ b/docs/er/api-ref/CreateVpcAttachment.html @@ -0,0 +1,443 @@ + + +

Creating a VPC Attachment

+

Function

This API is used to create a VPC attachment for an enterprise router.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Client-Token

+

No

+

String

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

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

Parameter

+

Mandatory

+

Type

+

Description

+

vpc_attachment

+

Yes

+

VpcAttachmentCreateRequest object

+

VPC attachment

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 VpcAttachmentCreateRequest

Parameter

+

Mandatory

+

Type

+

Description

+

vpc_id

+

Yes

+

String

+

VPC ID. The value contains a maximum of 36 characters in UUID format with hyphens (-).

+

name

+

Yes

+

String

+

VPC attachment name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

+

Minimum: 1

+

Maximum: 64

+

virsubnet_id

+

Yes

+

String

+

VPC subnet ID. The value contains a maximum of 36 characters in UUID format with hyphens (-).

+

description

+

No

+

String

+

Supplementary information. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

+

Minimum: 0

+

Maximum: 255

+

auto_create_vpc_routes

+

No

+

Boolean

+

The default value is false. If the value is set to true, a route with the enterprise router as the next hop will be automatically added to the route tables of the VPC.

+

Default: false

+

ipv6_enable

+

No

+

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.

+

Default: false

+

tags

+

No

+

Array of Tag objects

+

Tag information

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

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

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

+

value

+

No

+

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

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 6 Response header parameters

Parameter

+

Type

+

Description

+

X-Client-Token

+

-

+

Idempotence identifier

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

Parameter

+

Type

+

Description

+

vpc_attachment

+

VpcAttachmentDetails object

+

VPC attachment

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

VPC attachment ID

+

name

+

String

+

VPC attachment name

+

vpc_id

+

String

+

VPC id

+

virsubnet_id

+

String

+

VPC subnet ID

+

auto_create_vpc_routes

+

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.

+

Default: false

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

description

+

String

+

Supplementary information about the VPC attachment

+

project_id

+

String

+

Project ID

+

vpc_project_id

+

String

+

ID of the project that the VPC belongs to

+

ipv6_enable

+

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.

+

Default: false

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Creating a VPC attachment named vpc-atta

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231052/vpc-attachments
+
+{
+  "vpc_attachment" : {
+    "name" : "vpc-atta",
+    "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8"
+  }
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "vpc_attachment" : {
+    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "name" : "vpc-atta",
+    "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "ipv6_enable" : false,
+    "state" : "pending",
+    "auto_create_vpc_routes" : false,
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: VPC Attachments
+
+
+ diff --git a/docs/er/api-ref/DeleteEnterpriseRouter.html b/docs/er/api-ref/DeleteEnterpriseRouter.html new file mode 100644 index 000000000..bdbe72c4c --- /dev/null +++ b/docs/er/api-ref/DeleteEnterpriseRouter.html @@ -0,0 +1,73 @@ + + +

Deleting an Enterprise Router

+

Function

This API is used to delete an enterprise router.

+
+

URI

DELETE /v3/{project_id}/enterprise-router/instances/{er_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Example Requests

Deleting an enterprise router

+
DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/94c2b814-99dc-939a-e811-ae84c61ea3ff
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Enterprise Routers
+
+
+ diff --git a/docs/er/api-ref/DeleteFlowLog.html b/docs/er/api-ref/DeleteFlowLog.html new file mode 100644 index 000000000..ea01e1b68 --- /dev/null +++ b/docs/er/api-ref/DeleteFlowLog.html @@ -0,0 +1,84 @@ + + +

Deleting a Flow Log

+

Function

This API is used to delete a flow log.

+
+

Constraints

A flow log can be deleted only when it is in the available, deleting, or failed state.

+
+

URI

DELETE /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

flow_log_id

+

Yes

+

String

+

Flow log ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

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
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Flow Logs
+
+
+ diff --git a/docs/er/api-ref/DeleteResourceTag.html b/docs/er/api-ref/DeleteResourceTag.html new file mode 100644 index 000000000..a5120d6fb --- /dev/null +++ b/docs/er/api-ref/DeleteResourceTag.html @@ -0,0 +1,97 @@ + + +

Deleting Resource Tags

+

Function

This API is used to delete tags for resources of a specific type.

+
+

Constraints

This API is idempotent. The key cannot be left blank or be an empty string.

+
+

URI

DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key}

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

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key

+

project_id

+

Yes

+

String

+

Project ID

+

resource_id

+

Yes

+

String

+

Resource ID

+

resource_type

+

Yes

+

String

+

Resource type.

+

  • instance: enterprise router

    +

  • route-table: route table

    +

  • vpc-attachment: VPC attachment

    +

  • vgw-attachment: virtual gateway attachment

    +
+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Example Requests

DELETE https://{erouter-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/key1
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

No Content

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tags
+
+
+ diff --git a/docs/er/api-ref/DeleteRouteTable.html b/docs/er/api-ref/DeleteRouteTable.html new file mode 100644 index 000000000..5871d3648 --- /dev/null +++ b/docs/er/api-ref/DeleteRouteTable.html @@ -0,0 +1,81 @@ + + +

Deleting a Route Table

+

Function

This API is used to delete a route table.

+
+

URI

DELETE /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Example Requests

DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231056/route-tables/4ab54142-7c92-48ad-8288-77727a231052
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Route Tables
+
+
+ diff --git a/docs/er/api-ref/DeleteStaticRoute.html b/docs/er/api-ref/DeleteStaticRoute.html new file mode 100644 index 000000000..f901d3c4d --- /dev/null +++ b/docs/er/api-ref/DeleteStaticRoute.html @@ -0,0 +1,81 @@ + + +

Deleting a Static Route

+

Function

This API is used to delete a static route.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+

route_id

+

Yes

+

String

+

Route ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

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
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Routes
+
+
+ diff --git a/docs/er/api-ref/DeleteVpcAttachment.html b/docs/er/api-ref/DeleteVpcAttachment.html new file mode 100644 index 000000000..94f224523 --- /dev/null +++ b/docs/er/api-ref/DeleteVpcAttachment.html @@ -0,0 +1,84 @@ + + +

Deleting a VPC Attachment

+

Function

This API is used to delete a VPC attachment.

+
+

Constraints

A VPC attachment can be deleted only when it is in the available, deleting, or failed state.

+
+

URI

DELETE /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

vpc_attachment_id

+

Yes

+

String

+

VPC attachment ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

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
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: VPC Attachments
+
+
+ diff --git a/docs/er/api-ref/DisableFlowLog.html b/docs/er/api-ref/DisableFlowLog.html new file mode 100644 index 000000000..954c7b01b --- /dev/null +++ b/docs/er/api-ref/DisableFlowLog.html @@ -0,0 +1,245 @@ + + +

Disabling Flow Logs

+

Function

This API is used to disable flow logs.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/disable

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

flow_log_id

+

Yes

+

String

+

Flow log ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 202

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

Parameter

+

Type

+

Description

+

flow_log

+

FlowLog object

+

Flow log details

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 FlowLog

Parameter

+

Type

+

Description

+

id

+

String

+

Flow log ID

+

name

+

String

+

Flow log name

+

description

+

String

+

Flow log description

+

project_id

+

String

+

Project ID of the flow log task creator

+

resource_type

+

String

+

Resource type. The value is attachment.

+

resource_id

+

String

+

Resource ID

+

log_group_id

+

String

+

Log group ID

+

log_stream_id

+

String

+

Log stream ID

+

log_store_type

+

String

+

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

+

log_store_name

+

String

+

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

+

log_aggregation_interval

+

Integer

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

state

+

String

+

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

+

enabled

+

Boolean

+

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

+
+
+
+

Example Requests

Disabling flow logs

+
POST https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs/b216bc1d-5963-41a7-89f9-779a5128c5ac/disable
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "flow_log" : {
+    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
+    "name" : "flow_log_update",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "resource_type" : "attachment",
+    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
+    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
+    "log_store_type" : "LTS",
+    "log_aggregation_interval" : 600,
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2022-03-11T15:13:31Z",
+    "state" : "available",
+    "enabled" : true,
+    "description" : "Flow Logs"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Flow Logs
+
+
+ diff --git a/docs/er/api-ref/DisablePropagation.html b/docs/er/api-ref/DisablePropagation.html new file mode 100644 index 000000000..215fd26bc --- /dev/null +++ b/docs/er/api-ref/DisablePropagation.html @@ -0,0 +1,142 @@ + + +

Deleting a Route Propagation

+

Function

This API is used to delete a propagation from the route table of an enterprise router for an attachment.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disable-propagations

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

attachment_id

+

No

+

String

+

Unique ID of the attachment

+

route_policy

+

No

+

ImportRoutePolicy object

+

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

+
+
+ +
+ + + + + + + + + + + +
Table 3 ImportRoutePolicy

Parameter

+

Mandatory

+

Type

+

Description

+

import_policy_id

+

No

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+
+

Response Parameters

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
+
+{
+  "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Propagations
+
+
+ diff --git a/docs/er/api-ref/DisassociateRouteTable.html b/docs/er/api-ref/DisassociateRouteTable.html new file mode 100644 index 000000000..4def8b44a --- /dev/null +++ b/docs/er/api-ref/DisassociateRouteTable.html @@ -0,0 +1,143 @@ + + +

Deleting a Route Association

+

Function

This API is used to delete an association from the route table of an enterprise router for an attachment.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disassociate

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

attachment_id

+

No

+

String

+

Unique ID of the attachment

+

Maximum: 36

+

route_policy

+

No

+

ExportRoutePolicy object

+

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

+
+
+ +
+ + + + + + + + + + + +
Table 3 ExportRoutePolicy

Parameter

+

Mandatory

+

Type

+

Description

+

export_policy_id

+

No

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+
+

Response Parameters

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
+
+{
+  "attachment_id" : "2609ec92-ac19-4467-a527-7f9e690e7836"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Associations
+
+
+ diff --git a/docs/er/api-ref/EnableFlowLog.html b/docs/er/api-ref/EnableFlowLog.html new file mode 100644 index 000000000..25b57036b --- /dev/null +++ b/docs/er/api-ref/EnableFlowLog.html @@ -0,0 +1,245 @@ + + +

Enabling Flow Logs

+

Function

This API is used to enable flow logs.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/enable

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

flow_log_id

+

Yes

+

String

+

Flow log ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 202

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

Parameter

+

Type

+

Description

+

flow_log

+

FlowLog object

+

Flow log details

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 FlowLog

Parameter

+

Type

+

Description

+

id

+

String

+

Flow log ID

+

name

+

String

+

Flow log name

+

description

+

String

+

Flow log description

+

project_id

+

String

+

Project ID of the flow log task creator

+

resource_type

+

String

+

Resource type. The value is attachment.

+

resource_id

+

String

+

Resource ID

+

log_group_id

+

String

+

Log group ID

+

log_stream_id

+

String

+

Log stream ID

+

log_store_type

+

String

+

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

+

log_store_name

+

String

+

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

+

log_aggregation_interval

+

Integer

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

state

+

String

+

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

+

enabled

+

Boolean

+

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

+
+
+
+

Example Requests

Enabling flow logs

+
POST https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs/b216bc1d-5963-41a7-89f9-779a5128c5ac/enable
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "flow_log" : {
+    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
+    "name" : "flow_log_update",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "resource_type" : "attachment",
+    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
+    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
+    "log_store_type" : "LTS",
+    "log_aggregation_interval" : 600,
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2022-03-11T15:13:31Z",
+    "state" : "available",
+    "enabled" : true,
+    "description" : "Flow Logs"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Flow Logs
+
+
+ diff --git a/docs/er/api-ref/EnablePropagation.html b/docs/er/api-ref/EnablePropagation.html new file mode 100644 index 000000000..e5b4e5ce5 --- /dev/null +++ b/docs/er/api-ref/EnablePropagation.html @@ -0,0 +1,342 @@ + + +

Creating a Route Propagation

+

Function

This API is used to create a route propagation. A propagation can be created for each attachment to propagate routes to one or more route tables on an enterprise router.

+
+

URI

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/enable-propagations

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Client-Token

+

No

+

String

+

Idempotence identifier

+

Minimum: 1

+

Maximum: 64

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

Parameter

+

Mandatory

+

Type

+

Description

+

attachment_id

+

No

+

String

+

Unique ID of the attachment

+

route_policy

+

No

+

ImportRoutePolicy object

+

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

+
+
+ +
+ + + + + + + + + + + +
Table 4 ImportRoutePolicy

Parameter

+

Mandatory

+

Type

+

Description

+

import_policy_id

+

No

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 5 Response header parameters

Parameter

+

Type

+

Description

+

X-Client-Token

+

-

+

Idempotence identifier

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

Parameter

+

Type

+

Description

+

propagation

+

Propagation object

+

Propagation details

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Unique association ID

+

project_id

+

String

+

Project ID

+

er_id

+

String

+

Enterprise router ID

+

route_table_id

+

String

+

Unique ID of the route table

+

attachment_id

+

String

+

Unique ID of the attachment

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

resource_id

+

String

+

Unique ID of the attachment

+

route_policy

+

ImportRoutePolicy object

+

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

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+
+
+ +
+ + + + + + + + + +
Table 8 ImportRoutePolicy

Parameter

+

Type

+

Description

+

import_policy_id

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+
+

Example Requests

Creating a route propagation

+
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/ad838a5e-dbef-22cc-b1d9-cb46bef77ae8/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/enable-propagations
+
+{
+  "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64"
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "propagation" : {
+    "id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
+    "route_table_id" : "91c013e2-d65a-474e-9177-c3e1799ca726",
+    "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64",
+    "resource_type" : "vpc",
+    "resource_id" : "4e5fe97c-82bc-432e-87d8-06d7e157dffa",
+    "route_policy" : {
+      "import_policy_id" : ""
+    },
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Propagations
+
+
+ diff --git a/docs/er/api-ref/EnterpriseRouterInstance.html b/docs/er/api-ref/EnterpriseRouterInstance.html new file mode 100644 index 000000000..d9b1fe344 --- /dev/null +++ b/docs/er/api-ref/EnterpriseRouterInstance.html @@ -0,0 +1,24 @@ + + +

Enterprise Routers

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/ErrorCode.html b/docs/er/api-ref/ErrorCode.html new file mode 100644 index 000000000..4983944f8 --- /dev/null +++ b/docs/er/api-ref/ErrorCode.html @@ -0,0 +1,477 @@ + + +

Error Codes

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Error Codes

+

Error Message

+

Description

+

Solution

+

400

+

ER.04001003

+

The enterprise router is unavailable or is being operated.

+

The enterprise router is unavailable or is being operated.

+

Check whether the enterprise router is available and try again.

+

400

+

ER.04001104

+

The default route table association function is not enabled.

+

The default route table association function is not enabled.

+

Enable the default route table association function and try again.

+

400

+

ER.04001105

+

The default route table propagation function is not enabled.

+

The default route table propagation function is not enabled.

+

Enable the default route table propagation function and try again.

+

400

+

ER.04001106

+

Invalid ASN.

+

Invalid ASN.

+

Enter a valid ASN.

+

400

+

ER.04002002

+

The association already exists.

+

The association already exists.

+

Check the association and try again.

+

400

+

ER.04002003

+

An operation is being performed on this association.

+

An operation is being performed on this association.

+

Try again after the association status changes to Normal.

+

400

+

ER.04003002

+

The propagation already exists.

+

The propagation already exists.

+

Check the propagation and try again.

+

400

+

ER.04003003

+

An operation is being performed on this propagation.

+

An operation is being performed on this propagation.

+

Try again after the propagation status changes to Normal.

+

400

+

ER.04004002

+

This attachment is being used by other resources.

+

This attachment is being used by other resources.

+

Check whether the attachment is being used by other resources. If there are such resources, delete them and try again.

+

400

+

ER.04004003

+

This attachment is unavailable or is being operated.

+

This attachment is unavailable or is being operated.

+

Check whether the attachment is available and try again.

+

400

+

ER.04004004

+

This resource is being used by another attachment.

+

This resource is being used by another attachment.

+

Check whether an attachment has been created for the resource.

+

400

+

ER.04004101

+

This route already exists in the VPC route table.

+

This route already exists in the VPC route table.

+

Disable the Auto Add Routes function and try again.

+

400

+

ER.04004102

+

Failed to add the route to the VPC route table.

+

Failed to add the route to the VPC route table.

+

Check whether a route with the same destination already exists in the VPC route table.

+

400

+

ER.04005003

+

This route table is unavailable or is being operated.

+

This route table is unavailable or is being operated.

+

Check whether the route table is available and try again.

+

400

+

ER.04006002

+

The destination of the route already exists.

+

The destination of the route already exists.

+

Check the destination in the route.

+

400

+

ER.04006103

+

The destination of the route is invalid.

+

The destination of the route is invalid.

+

Check the destination in the route.

+

400

+

ER.04006104

+

The destination cannot be 127.0.0.0/8, 169.254.0.0/16, 224.0.0.0/4, or any of their subnets.

+

The destination cannot be 127.0.0.0/8, 169.254.0.0/16, 224.0.0.0/4, or any of their subnets.

+

Do not add a route with destination set to 127.0.0.0/8, 169.254.0.0/16, 224.0.0.0/4, or any of their subnets.

+

400

+

ER.04006105

+

The network instance type of the next hop is not supported.

+

The network instance type of the next hop is not supported.

+

Use another type of network instance.

+

400

+

ER.04006106

+

A blackhole route cannot have a next hop. A non-blackhole route must have a next hop.

+

Invalid route.

+

Check the route.

+

400

+

ER.04008500

+

Flow logs are not supported by the resource type.

+

Flow logs are not supported by the resource type.

+

Check the resource type.

+

400

+

ER.04008501

+

The flow log task does not exist.

+

The flow log task does not exist.

+

Check the flow log ID.

+

400

+

ER.04008502

+

The flow log task is being operated.

+

The flow log task is being operated.

+

Check the flow log task status and try again later.

+

400

+

ER.04008503

+

The flow log task already exists.

+

The flow log task already exists.

+

Check the flow log task.

+

400

+

ER.04009005

+

Invalid parameters.

+

Invalid parameters.

+

Check the parameters.

+

400

+

ER.04009008

+

Insufficient quota.

+

Insufficient quota.

+

Submit a service ticket to apply for quota increase.

+

400

+

ER.04009009

+

The quota type does not exist.

+

The quota type does not exist.

+

Check the parameters.

+

400

+

ER.04009011

+

The resource is frozen.

+

The resource is frozen.

+

Unfreeze the resource and try again.

+

400

+

ER.04009012

+

This account is frozen or restricted.

+

This account is frozen or restricted.

+

Contact customer service.

+

400

+

ER.04009013

+

This enterprise router has frozen attachments.

+

This enterprise router has frozen attachments.

+

Contact customer service.

+

400

+

ER.04009019

+

This feature is not available yet.

+

This feature is not available yet.

+

Contact customer service.

+

404

+

ER.04041001

+

This enterprise router does not exist.

+

This enterprise router does not exist.

+

Check the parameters.

+

404

+

ER.04042001

+

This association does not exist.

+

This association does not exist.

+

Check the parameters.

+

404

+

ER.04043001

+

This propagation does not exist.

+

This propagation does not exist.

+

Check the parameters.

+

404

+

ER.04044001

+

This attachment does not exist.

+

This attachment does not exist.

+

Check the parameters.

+

404

+

ER.04045001

+

This route table does not exist.

+

This route table does not exist.

+

Check the parameters.

+

404

+

ER.04046001

+

This route does not exist.

+

This route does not exist.

+

Check the parameters.

+

409

+

ER.04091002

+

This enterprise router is being used by other resources.

+

This enterprise router is being used by other resources.

+

Delete the resources and try again.

+

409

+

ER.04095002

+

This route table is being used by other resources.

+

This route table is being used by other resources.

+

Delete the resources and try again.

+

409

+

ER.04095104

+

The default association route table cannot be deleted.

+

The default association route table cannot be deleted.

+

Disable the Default Route Table Association function.

+

409

+

ER.04095105

+

The default propagation route table cannot be deleted.

+

The default propagation route table cannot be deleted.

+

Disable the Default Route Table Propagation function.

+

503

+

ER.05039006

+

This service is temporarily unavailable.

+

This service is temporarily unavailable.

+

Contact customer service or try again later.

+
+
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/er/api-ref/FlowLog.html b/docs/er/api-ref/FlowLog.html new file mode 100644 index 000000000..b984b0bba --- /dev/null +++ b/docs/er/api-ref/FlowLog.html @@ -0,0 +1,28 @@ + + +

Flow Logs

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/ListAssociations.html b/docs/er/api-ref/ListAssociations.html new file mode 100644 index 000000000..630ce3290 --- /dev/null +++ b/docs/er/api-ref/ListAssociations.html @@ -0,0 +1,351 @@ + + +

Querying Route Associations

+

Function

This API is used to query route associations.

+
+

Constraints

Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (id, created_at, or updated_at) is supported.

+
+

URI

GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associations

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

attachment_id

+

No

+

Array

+

Attachment ID

+

resource_type

+

No

+

Array

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

state

+

No

+

Array

+

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

+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

associations

+

Array of Association objects

+

Route table associations

+

Array Length: 0 - 2000

+

request_id

+

String

+

Request ID

+

page_info

+

PageInfo object

+

Pagination query information

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

Parameter

+

Type

+

Description

+

id

+

String

+

Unique association ID

+

Maximum: 36

+

route_table_id

+

String

+

Unique ID of the route table

+

Maximum: 36

+

attachment_id

+

String

+

Unique ID of the attachment

+

Maximum: 36

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

resource_id

+

String

+

Unique ID of the attachment

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

route_policy

+

ExportRoutePolicy object

+

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

+
+
+ +
+ + + + + + + + + +
Table 5 ExportRoutePolicy

Parameter

+

Type

+

Description

+

export_policy_id

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 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

+
+
+
+

Example Requests

Querying route table associations

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

Example Responses

Status code: 200

+

OK

+
{
+  "associations" : [ {
+    "id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
+    "route_table_id" : "91c013e2-d65a-474e-9177-c3e1799ca726",
+    "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64",
+    "resource_type" : "vpc",
+    "resource_id" : "4e5fe97c-82bc-432e-87d8-06d7e157dffa",
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31",
+    "updated_at" : "2020-03-11T15:13:31",
+    "route_policy" : {
+      "export_policy_id" : ""
+    }
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 1
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Associations
+
+
+ diff --git a/docs/er/api-ref/ListAttachments.html b/docs/er/api-ref/ListAttachments.html new file mode 100644 index 000000000..10ed9776f --- /dev/null +++ b/docs/er/api-ref/ListAttachments.html @@ -0,0 +1,393 @@ + + +

Querying Attachments

+

Function

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

+
+

Constraints

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

state

+

No

+

Array

+

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

+

resource_type

+

No

+

Array

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

resource_id

+

No

+

Array

+

Attachment resource IDs

+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

attachments

+

Array of AttachmentDetails objects

+

Attachments

+

page_info

+

PageInfo object

+

Pagination query information

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Attachment ID

+

name

+

String

+

Attachment name

+

description

+

String

+

Attachment description

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

tags

+

Array of Tag objects

+

Enterprise router tags

+

project_id

+

String

+

Project ID

+

er_id

+

String

+

er id

+

resource_id

+

String

+

Attached resource ID on its own service console

+

resource_type

+

String

+

Attachment type.

+

  • vgw: virtual gateway attachments

    +

  • vpc: VPC attachments

    +
+

resource_project_id

+

String

+

ID of the project that the resource belongs to

+

associated

+

Boolean

+

Whether the attachment is associated.

+

route_table_id

+

String

+

Association route table ID

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 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

+
+
+
+

Example Requests

Querying attachments

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

Example Responses

Status code: 200

+

OK

+
{
+  "attachments" : [ {
+    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "name" : "vpc-001",
+    "description" : "vpc attachment",
+    "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "resource_type" : "vpc",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "state" : "available",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  }, {
+    "id" : "6f83b848-8331-4271-ac0c-ef94b7686403",
+    "name" : "vpc-002",
+    "description" : "for test",
+    "resource_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f",
+    "resource_type" : "vpc",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "state" : "available",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 2
+  },
+  "request_id" : "b715e131-3371-4e17-a2de-4f669e24439a"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Attachments
+
+
+ diff --git a/docs/er/api-ref/ListAvailabilityZone.html b/docs/er/api-ref/ListAvailabilityZone.html new file mode 100644 index 000000000..f59a42951 --- /dev/null +++ b/docs/er/api-ref/ListAvailabilityZone.html @@ -0,0 +1,159 @@ + + +

Querying AZs

+

Function

This API is used to query AZs where enterprise routers can be created. An enterprise router can be created only when an AZ is in the available state.

+
+

URI

GET /v3/{project_id}/enterprise-router/availability-zones

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

No

+

String

+

Enterprise router ID

+

bandwidth_size

+

No

+

Integer

+

Bandwidth size, in Mbit/s

+

Minimum: -1

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

availability_zones

+

Array of AvailableZone objects

+

AZ list

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 AvailableZone

Parameter

+

Type

+

Description

+

code

+

String

+

AZ code

+

state

+

String

+

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

+
+
+
+

Example Requests

Querying AZs

+
GET https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/availability-zones
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "availability_zones" : [ {
+    "code" : "az1",
+    "state" : "available"
+  }, {
+    "code" : "az2",
+    "state" : "unavailable"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AZs
+
+
+ diff --git a/docs/er/api-ref/ListEffectiveRoutes.html b/docs/er/api-ref/ListEffectiveRoutes.html new file mode 100644 index 000000000..3300d36ba --- /dev/null +++ b/docs/er/api-ref/ListEffectiveRoutes.html @@ -0,0 +1,298 @@ + + +

Querying Effective Routes

+

Function

This API is used to query effective routes. Pagination query is supported. Effective routes are preferred routes.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

route_table_id

+

Yes

+

String

+

Route table ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last route 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

+

No

+

Array

+

Destination address of the route

+

resource_type

+

No

+

Array

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

routes

+

Array of EffectiveRoute objects

+

Routes

+

request_id

+

String

+

Request ID

+

page_info

+

PageInfo object

+

Pagination query information

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

Parameter

+

Type

+

Description

+

route_id

+

String

+

Route ID

+

destination

+

String

+

Destination address of the route

+

next_hops

+

Array of RouteAttachment objects

+

Next hops of the routes

+

is_blackhole

+

Boolean

+

Whether the route is a blackhole route

+

route_type

+

String

+

Route type. Value options: static and propagation

+

address_group_id

+

String

+

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

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

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Attached resource ID

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

attachment_id

+

String

+

Attachment ID

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 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

+
+
+
+

Example Requests

Querying effective routes

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

Example Responses

Status code: 200

+

OK

+
{
+  "routes" : [ {
+    "route_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
+    "destination" : "192.168.0.0/16",
+    "next_hops" : [ {
+      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
+      "resource_type" : "vpc",
+      "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289"
+    } ],
+    "is_blackhole" : false,
+    "route_type" : "static"
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 1
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Routes
+
+
+ diff --git a/docs/er/api-ref/ListEnterpriseRouters.html b/docs/er/api-ref/ListEnterpriseRouters.html new file mode 100644 index 000000000..22024188a --- /dev/null +++ b/docs/er/api-ref/ListEnterpriseRouters.html @@ -0,0 +1,414 @@ + + +

Querying Enterprise Routers

+

Function

This API is used to query enterprise routers.

+
+

Constraints

Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together. Only sorting by a single field (id, name, description, created_at, or updated_at) is supported.

+
+

URI

GET /v3/{project_id}/enterprise-router/instances

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

enterprise_project_id

+

No

+

Array

+

Enterprise project ID

+

state

+

No

+

Array

+

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

+

id

+

No

+

Array

+

Query by resource ID. Multiple resources can be queried at a time.

+

resource_id

+

No

+

Array

+

Attachment resource IDs

+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instances

+

Array of EnterpriseRouter objects

+

Enterprise routers

+

page_info

+

PageInfo object

+

Pagination query information

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Enterprise router ID

+

name

+

String

+

Enterprise router name

+

description

+

String

+

Supplementary information about an enterprise router

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

charge_mode

+

String

+

Default: postPaid

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

enterprise_project_id

+

String

+

Enterprise project ID

+

project_id

+

String

+

Project ID

+

asn

+

Long

+

Enterprise router BGP ASN

+

enable_default_propagation

+

Boolean

+

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

+

enable_default_association

+

Boolean

+

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

+

default_propagation_route_table_id

+

String

+

Default propagation route table ID

+

default_association_route_table_id

+

String

+

Default association route table ID

+

availability_zone_ids

+

Array of strings

+

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

+

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

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 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

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "instances" : [ {
+    "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
+    "name" : "my_er",
+    "description" : "this is my first enterprise router",
+    "asn" : 64512,
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "enable_default_association" : true,
+    "enable_default_propagation" : true,
+    "default_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
+    "default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
+    "auto_accept_shared_attachments" : false,
+    "created_at" : "2019-09-06 02:11:13Z",
+    "updated_at" : "2019-09-06 02:11:13Z",
+    "tags" : [ {
+      "key" : "key",
+      "value" : "value"
+    } ],
+    "enterprise_project_id" : 0,
+    "availability_zone_ids" : [ "az1", "az2" ]
+  } ],
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
+  "page_info" : {
+    "next_marker" : "2",
+    "current_count" : 1
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Enterprise Routers
+
+
+ diff --git a/docs/er/api-ref/ListFlowLogs.html b/docs/er/api-ref/ListFlowLogs.html new file mode 100644 index 000000000..6cef23ebe --- /dev/null +++ b/docs/er/api-ref/ListFlowLogs.html @@ -0,0 +1,350 @@ + + +

Querying Flow Logs

+

Function

This API is used to query the flow log list.

+
+

Constraints

+
+

URI

GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

resource_type

+

No

+

String

+

Resource type

+

resource_id

+

No

+

Array

+

Attachment resource IDs

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

flow_logs

+

Array of FlowLog objects

+

Flow log details

+

request_id

+

String

+

Request ID

+

page_info

+

PageInfo object

+

Pagination query information

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

Parameter

+

Type

+

Description

+

id

+

String

+

Flow log ID

+

name

+

String

+

Flow log name

+

description

+

String

+

Flow log description

+

project_id

+

String

+

Project ID of the flow log task creator

+

resource_type

+

String

+

Resource type. The value is attachment.

+

resource_id

+

String

+

Resource ID

+

log_group_id

+

String

+

Log group ID

+

log_stream_id

+

String

+

Log stream ID

+

log_store_type

+

String

+

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

+

log_store_name

+

String

+

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

+

log_aggregation_interval

+

Integer

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

state

+

String

+

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

+

enabled

+

Boolean

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 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

+
+
+
+

Example Requests

Querying flow logs

+
GET https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "flow_logs" : [ {
+    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
+    "name" : "flow_log",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "resource_type" : "attachment",
+    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
+    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
+    "log_store_type" : "LTS",
+    "log_aggregation_interval" : 600,
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2022-03-11T15:13:31Z",
+    "state" : "available",
+    "enabled" : true,
+    "description" : "Flow Logs"
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 1
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Flow Logs
+
+
+ diff --git a/docs/er/api-ref/ListProjectTags.html b/docs/er/api-ref/ListProjectTags.html new file mode 100644 index 000000000..e01036c90 --- /dev/null +++ b/docs/er/api-ref/ListProjectTags.html @@ -0,0 +1,139 @@ + + +

Querying Project Tags

+

Function

This API is used to query tags of resources of a specific type.

+
+

URI

GET /v3/{project_id}/{resource_type}/tags

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

resource_type

+

Yes

+

String

+

Resource type.

+

  • instance: enterprise router

    +

  • route-table: route table

    +

  • vpc-attachment: VPC attachment

    +

  • vgw-attachment: virtual gateway attachment

    +
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

tags

+

Array of Tags objects

+

Tags

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 Tags

Parameter

+

Type

+

Description

+

key

+

String

+

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

+

values

+

Array of strings

+

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

+
+
+
+

Example Requests

Querying tags of an enterprise router

+
https://{erouter_endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/tags
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "tags" : [ {
+    "key" : "keys",
+    "values" : [ "value" ]
+  }, {
+    "key" : "key3",
+    "values" : [ "value3", "value33" ]
+  }, {
+    "key" : "key1",
+    "values" : [ "value1" ]
+  }, {
+    "key" : "key2",
+    "values" : [ "value2", "value22" ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tags
+
+
+ diff --git a/docs/er/api-ref/ListPropagations.html b/docs/er/api-ref/ListPropagations.html new file mode 100644 index 000000000..623023a30 --- /dev/null +++ b/docs/er/api-ref/ListPropagations.html @@ -0,0 +1,363 @@ + + +

Querying Route Propagations

+

Function

This API is used to query route propagations.

+
+

Constraints

Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (id, created_at, or updated_at) is supported.

+
+

URI

GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

attachment_id

+

No

+

Array

+

Attachment ID

+

resource_type

+

No

+

Array

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

state

+

No

+

Array

+

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

+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

propagations

+

Array of Propagation objects

+

Route propagations

+

Array Length: 0 - 2000

+

request_id

+

String

+

Request ID

+

page_info

+

PageInfo object

+

Pagination query information

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

Parameter

+

Type

+

Description

+

id

+

String

+

Unique association ID

+

project_id

+

String

+

Project ID

+

er_id

+

String

+

Enterprise router ID

+

route_table_id

+

String

+

Unique ID of the route table

+

attachment_id

+

String

+

Unique ID of the attachment

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

resource_id

+

String

+

Unique ID of the attachment

+

route_policy

+

ImportRoutePolicy object

+

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

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+
+
+ +
+ + + + + + + + + +
Table 5 ImportRoutePolicy

Parameter

+

Type

+

Description

+

import_policy_id

+

String

+

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

+

Minimum: 0

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 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

+
+
+
+

Example Requests

Querying route table propagations

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/7dec531a-7714-11eb-9439-0242ac130002/route-tables/91c013e2-d65a-474e-9177-c3e1799ca726/propagations
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "propagations" : [ {
+    "id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
+    "er_id" : "7dec531a-7714-11eb-9439-0242ac130002",
+    "route_table_id" : "91c013e2-d65a-474e-9177-c3e1799ca726",
+    "attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64",
+    "resource_type" : "vpc",
+    "resource_id" : "4e5fe97c-82bc-432e-87d8-06d7e157dffa",
+    "route_policy" : {
+      "import_policy_id" : ""
+    },
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 1
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Propagations
+
+
+ diff --git a/docs/er/api-ref/ListRouteTables.html b/docs/er/api-ref/ListRouteTables.html new file mode 100644 index 000000000..abab1348a --- /dev/null +++ b/docs/er/api-ref/ListRouteTables.html @@ -0,0 +1,386 @@ + + +

Querying Route Tables

+

Function

This API is used to query route tables.

+
+

Constraints

+
+

URI

GET /v3/{project_id}/enterprise-router/{er_id}/route-tables

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

state

+

No

+

Array

+

Status

+

is_default_propagation_table

+

No

+

Boolean

+

Whether the route table is the default propagation route table

+

is_default_association_table

+

No

+

Boolean

+

Whether the route table is the default association route table

+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

route_tables

+

Array of RouteTable objects

+

Route tables

+

request_id

+

String

+

Request ID

+

page_info

+

PageInfo object

+

Pagination query information

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

Parameter

+

Type

+

Description

+

id

+

String

+

Route table ID

+

name

+

String

+

Route table name

+

description

+

String

+

Supplementary information

+

is_default_association

+

Boolean

+

Whether the route table is the default association route table.

+

Default: false

+

is_default_propagation

+

Boolean

+

Whether the route table is the default propagation route table.

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag

+

bgp_options

+

BgpOptions object

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

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

Parameter

+

Type

+

Description

+

load_balancing_as_path_ignore

+

Boolean

+

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

+

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.

+
+
+ +
+ + + + + + + + + + + + + +
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

+
+
+
+

Example Requests

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

Example Responses

Status code: 200

+

OK

+
{
+  "route_tables" : [ {
+    "id" : "4ab54142-7c92-48ad-8288-77727a231052",
+    "is_default_association" : false,
+    "is_default_propagation" : false,
+    "name" : "my-router-table1",
+    "description" : "rtb-for-a",
+    "state" : "available",
+    "tags" : [ {
+      "key" : "key",
+      "value" : "value"
+    } ]
+  }, {
+    "id" : "4ab54142-7c92-48ad-8288-77727a231053",
+    "is_default_association" : false,
+    "is_default_propagation" : false,
+    "name" : "my-router-table2",
+    "description" : "rtb-for-b",
+    "state" : "available",
+    "tags" : [ {
+      "key" : "key",
+      "value" : "value"
+    } ]
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 2
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Route Tables
+
+
+ diff --git a/docs/er/api-ref/ListStaticRoutes.html b/docs/er/api-ref/ListStaticRoutes.html new file mode 100644 index 000000000..df9b57ab3 --- /dev/null +++ b/docs/er/api-ref/ListStaticRoutes.html @@ -0,0 +1,353 @@ + + +

Querying Static Routes

+

Function

This API is used to query static routes.

+
+

Constraints

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

route_table_id

+

Yes

+

String

+

Route table ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

destination

+

No

+

Array

+

Destination address of the route

+

attachment_id

+

No

+

Array

+

Attachment ID

+

resource_type

+

No

+

Array

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

routes

+

Array of Route objects

+

Routes

+

request_id

+

String

+

Request ID

+

page_info

+

PageInfo object

+

Pagination query information

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

Parameter

+

Type

+

Description

+

id

+

String

+

Route ID

+

type

+

String

+

Route type. The value is static.

+

state

+

String

+

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

+

is_blackhole

+

Boolean

+

Whether the route is a blackhole route

+

destination

+

String

+

Destination address of the route

+

attachments

+

Array of RouteAttachment objects

+

Next hops

+

route_table_id

+

String

+

Route table ID

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

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

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Attached resource ID

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

attachment_id

+

String

+

Attachment ID

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 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

+
+
+
+

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

+
{
+  "routes" : [ {
+    "id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
+    "type" : "static",
+    "destination" : "192.168.0.0/16",
+    "attachments" : [ {
+      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
+      "resource_type" : "vpc",
+      "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289"
+    } ],
+    "route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 1
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Routes
+
+
+ diff --git a/docs/er/api-ref/ListVpcAttachments.html b/docs/er/api-ref/ListVpcAttachments.html new file mode 100644 index 000000000..9e17ca239 --- /dev/null +++ b/docs/er/api-ref/ListVpcAttachments.html @@ -0,0 +1,386 @@ + + +

Querying VPC Attachments

+

Function

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

+
+

Constraints

VPC attachments can be queried in the following methods:

+ +
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

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

+

Minimum: 0

+

Maximum: 2000

+

marker

+

No

+

String

+

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

+

Minimum: 1

+

Maximum: 128

+

state

+

No

+

Array

+

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

+

id

+

No

+

Array

+

Query by resource ID. Multiple resources can be queried at a time.

+

sort_key

+

No

+

Array

+

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

+

sort_dir

+

No

+

Array

+

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

+

vpc_id

+

No

+

Array

+

VPC id

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

vpc_attachments

+

Array of VpcAttachmentDetails objects

+

VPC attachments

+

page_info

+

PageInfo object

+

Pagination query information

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

VPC attachment ID

+

name

+

String

+

VPC attachment name

+

vpc_id

+

String

+

VPC id

+

virsubnet_id

+

String

+

VPC subnet ID

+

auto_create_vpc_routes

+

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.

+

Default: false

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

description

+

String

+

Supplementary information about the VPC attachment

+

project_id

+

String

+

Project ID

+

vpc_project_id

+

String

+

ID of the project that the VPC belongs to

+

ipv6_enable

+

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.

+

Default: false

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 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

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "vpc_attachments" : [ {
+    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "name" : "vpc-attach-01",
+    "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "ipv6_enable" : false,
+    "state" : "available",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  }, {
+    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "name" : "vpc-attach-01",
+    "vpc_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f",
+    "virsubnet_id" : "2b55f334-a15e-43a9-ab11-b34c2dbb6fac",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "ipv6_enable" : false,
+    "state" : "available",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  } ],
+  "page_info" : {
+    "next_marker" : "1",
+    "current_count" : 2
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: VPC Attachments
+
+
+ diff --git a/docs/er/api-ref/PARAMETERS.txt b/docs/er/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/er/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/er/api-ref/Propagation.html b/docs/er/api-ref/Propagation.html new file mode 100644 index 000000000..6c348c9ff --- /dev/null +++ b/docs/er/api-ref/Propagation.html @@ -0,0 +1,20 @@ + + +

Propagations

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/QuotaManager.html b/docs/er/api-ref/QuotaManager.html new file mode 100644 index 000000000..d0eea7171 --- /dev/null +++ b/docs/er/api-ref/QuotaManager.html @@ -0,0 +1,16 @@ + + +

Quota Management

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/Route.html b/docs/er/api-ref/Route.html new file mode 100644 index 000000000..f25e42af5 --- /dev/null +++ b/docs/er/api-ref/Route.html @@ -0,0 +1,26 @@ + + +

Routes

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/RouteTable.html b/docs/er/api-ref/RouteTable.html new file mode 100644 index 000000000..4f778d096 --- /dev/null +++ b/docs/er/api-ref/RouteTable.html @@ -0,0 +1,24 @@ + + +

Route Tables

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/ShowAttachment.html b/docs/er/api-ref/ShowAttachment.html new file mode 100644 index 000000000..e1747373e --- /dev/null +++ b/docs/er/api-ref/ShowAttachment.html @@ -0,0 +1,245 @@ + + +

Querying Details About an Attachment

+

Function

This API is used to query details about an attachment.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

attachment_id

+

Yes

+

String

+

Attachment ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

attachment

+

AttachmentResponse object

+

Attachment basic information

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

name

+

String

+

Attachment name

+

id

+

String

+

Attachment ID

+

description

+

String

+

Supplementary information

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

tags

+

Array of Tag objects

+

Enterprise router tags

+

project_id

+

String

+

Project ID

+

resource_id

+

String

+

Attached resource ID on its own service console

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

resource_project_id

+

String

+

ID of the project that the resource belongs to

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Querying details about an attachment

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/212d3f0b-8496-472d-bc99-05a7c96d6655/attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "attachment" : {
+    "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
+    "name" : "vpc attachment",
+    "description" : "vpc prod",
+    "state" : "avaliable",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "resource_type" : "vpc"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Attachments
+
+
+ diff --git a/docs/er/api-ref/ShowEnterpriseRouter.html b/docs/er/api-ref/ShowEnterpriseRouter.html new file mode 100644 index 000000000..e1e6fd12c --- /dev/null +++ b/docs/er/api-ref/ShowEnterpriseRouter.html @@ -0,0 +1,287 @@ + + +

Querying Details About an Enterprise Router

+

Function

This API is used to query details about an enterprise router.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance

+

EnterpriseRouter object

+

Enterprise router

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 EnterpriseRouter

Parameter

+

Type

+

Description

+

id

+

String

+

Enterprise router ID

+

name

+

String

+

Enterprise router name

+

description

+

String

+

Supplementary information about an enterprise router

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

charge_mode

+

String

+

Default: postPaid

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

enterprise_project_id

+

String

+

Enterprise project ID

+

project_id

+

String

+

Project ID

+

asn

+

Long

+

Enterprise router BGP ASN

+

enable_default_propagation

+

Boolean

+

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

+

enable_default_association

+

Boolean

+

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

+

default_propagation_route_table_id

+

String

+

Default propagation route table ID

+

default_association_route_table_id

+

String

+

Default association route table ID

+

availability_zone_ids

+

Array of strings

+

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

+

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

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Querying details about an enterprise router with a specified ID

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/08d5a9564a704afda6039ae2babbef3c
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "instance" : {
+    "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
+    "name" : "my_er",
+    "description" : "this is my first enterprise router",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "state" : "pending",
+    "asn" : 64512,
+    "enable_default_association" : true,
+    "enable_default_propagation" : true,
+    "default_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
+    "default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
+    "auto_accept_shared_attachments" : false,
+    "availability_zone_ids" : [ "az1" ],
+    "created_at" : "2019-09-06 02:11:13Z",
+    "updated_at" : "2019-09-06 02:11:13Z"
+  },
+  "request_id" : "14c2b814-99dc-939b-e81c-ae84c61ea3f7"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Enterprise Routers
+
+
+ diff --git a/docs/er/api-ref/ShowFlowLog.html b/docs/er/api-ref/ShowFlowLog.html new file mode 100644 index 000000000..3766f7d21 --- /dev/null +++ b/docs/er/api-ref/ShowFlowLog.html @@ -0,0 +1,245 @@ + + +

Querying Details About a Flow Log

+

Function

This API is used to query details about a flow log.

+
+

URI

GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

flow_log_id

+

Yes

+

String

+

Flow log ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

flow_log

+

FlowLog object

+

Flow log details

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 FlowLog

Parameter

+

Type

+

Description

+

id

+

String

+

Flow log ID

+

name

+

String

+

Flow log name

+

description

+

String

+

Flow log description

+

project_id

+

String

+

Project ID of the flow log task creator

+

resource_type

+

String

+

Resource type. The value is attachment.

+

resource_id

+

String

+

Resource ID

+

log_group_id

+

String

+

Log group ID

+

log_stream_id

+

String

+

Log stream ID

+

log_store_type

+

String

+

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

+

log_store_name

+

String

+

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

+

log_aggregation_interval

+

Integer

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

state

+

String

+

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

+

enabled

+

Boolean

+

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

+
+
+
+

Example Requests

Querying flow logs

+
GET https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs/b216bc1d-5963-41a7-89f9-779a5128c5ac
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "flow_log" : {
+    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
+    "name" : "flow_log",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "resource_type" : "attachment",
+    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
+    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
+    "log_store_type" : "LTS",
+    "log_aggregation_interval" : 600,
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2022-03-11T15:13:31Z",
+    "state" : "available",
+    "enabled" : true,
+    "description" : "Flow Logs"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Flow Logs
+
+
+ diff --git a/docs/er/api-ref/ShowQuotas.html b/docs/er/api-ref/ShowQuotas.html new file mode 100644 index 000000000..4e26ce30a --- /dev/null +++ b/docs/er/api-ref/ShowQuotas.html @@ -0,0 +1,234 @@ + + +

Querying Quotas

+

Function

This API is used to query the used quotas of resources, such as enterprise routers and VPC attachments.

+
+

URI

GET /v3/{project_id}/enterprise-router/quotas

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

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

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

Array

+

You can query the quotas of the following resources:

+

  • er_instance: Total and used quotas of enterprise routers

    +

  • vpc_attachment: Total and used quotas of VPC attachments

    +

  • route_table: Total and used quotas of route tables

    +

  • static_route: Total and used quotas of static routes

    +

  • vpc_er: Total and used quotas of enterprise routers that a VPC can be attached to

    +

  • flow_log: Total and used quotas of flow logs that can be created for each attachment

    +

  • connect_attachment: Total and used quotas of Connect attachments. This type of attachments is not supported.

    +

  • dc_attachment: Total and used quotas of virtual gateway attachments. This type of attachments is not supported.

    +

  • vpn_attachment: Total and used quotas of VPN gateway attachments. This type of attachments is not supported.

    +

  • peering_attachment: Total and used quotas of peering connection attachments. This type of attachments is not supported.

    +

  • can_attachment: Total and used quotas of intelligent access gateway attachments. This type of attachments is not supported.

    +
+

erId

+

No

+

Object

+

Enterprise router ID

+

routeTableId

+

No

+

Object

+

Route table ID

+

vpcId

+

No

+

Object

+

VPC ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

quotas

+

Array of Quota objects

+

Used quota details

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Quota

Parameter

+

Type

+

Description

+

quota_key

+

String

+

Quota type

+

quota_limit

+

Long

+

Available quota. The value -1 indicates that there is no quota limit.

+

used

+

Long

+

Used quota

+

unit

+

String

+

Measurement unit of used quotas

+
+
+
+

Example Requests

Querying the resource quotas

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/quotas
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "quotas" : [ {
+    "quota_key" : "er_instance",
+    "quota_limit" : 1,
+    "used" : 0,
+    "unit" : "count"
+  }, {
+    "quota_key" : "dc_attachment",
+    "quota_limit" : 2,
+    "used" : 0,
+    "unit" : "count"
+  }, {
+    "quota_key" : "route_table",
+    "quota_limit" : 20,
+    "used" : 5,
+    "unit" : "count"
+  }, {
+    "quota_key" : "static_route",
+    "quota_limit" : 500,
+    "used" : 2,
+    "unit" : "count"
+  }, {
+    "quota_key" : "can_attachment",
+    "quota_limit" : 10,
+    "used" : 0,
+    "unit" : "count"
+  }, {
+    "quota_key" : "connect_attachment",
+    "quota_limit" : 20,
+    "used" : 0,
+    "unit" : "count"
+  }, {
+    "quota_key" : "peering_attachment",
+    "quota_limit" : 10,
+    "used" : 0,
+    "unit" : "count"
+  }, {
+    "quota_key" : "vpn_attachment",
+    "quota_limit" : 10,
+    "used" : 0,
+    "unit" : "count"
+  }, {
+    "quota_key" : "flow_log",
+    "quota_limit" : 20,
+    "used" : 4,
+    "unit" : "count"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/er/api-ref/ShowResourceTag.html b/docs/er/api-ref/ShowResourceTag.html new file mode 100644 index 000000000..a728c712b --- /dev/null +++ b/docs/er/api-ref/ShowResourceTag.html @@ -0,0 +1,149 @@ + + +

Querying Resource Tags

+

Function

This API is used to query tags of resources of a specific type.

+
+

URI

GET /v3/{project_id}/{resource_type}/{resource_id}/tags

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

resource_id

+

Yes

+

String

+

Resource ID

+

resource_type

+

Yes

+

String

+

Resource type.

+

  • instance: enterprise router

    +

  • route-table: route table

    +

  • vpc-attachment: VPC attachment

    +

  • vgw-attachment: virtual gateway attachment

    +
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

tags

+

Array of Tag objects

+

Tags

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 Tag

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Querying tags of an enterprise router

+
https://{erouter_endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/f1a28dfd-186f-4625-b6b1-f05e5e8609c0/tags
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "tags" : [ {
+    "key" : "key2",
+    "value" : "value2"
+  }, {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key3",
+    "value" : "value3"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tags
+
+
+ diff --git a/docs/er/api-ref/ShowRouteTable.html b/docs/er/api-ref/ShowRouteTable.html new file mode 100644 index 000000000..4df950db9 --- /dev/null +++ b/docs/er/api-ref/ShowRouteTable.html @@ -0,0 +1,261 @@ + + +

Querying Details About a Route Table

+

Function

This API is used to query details about a route table.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

route_table

+

RouteTable object

+

Route table

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 RouteTable

Parameter

+

Type

+

Description

+

id

+

String

+

Route table ID

+

name

+

String

+

Route table name

+

description

+

String

+

Supplementary information

+

is_default_association

+

Boolean

+

Whether the route table is the default association route table.

+

Default: false

+

is_default_propagation

+

Boolean

+

Whether the route table is the default propagation route table.

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag

+

bgp_options

+

BgpOptions object

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 BgpOptions

Parameter

+

Type

+

Description

+

load_balancing_as_path_ignore

+

Boolean

+

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

+

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.

+
+
+
+

Example Requests

Querying details about a route table

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f6/route-tables/4ab54142-7c92-48ad-8288-77727a231052
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "route_table" : {
+    "id" : "4ab54142-7c92-48ad-8288-77727a231052",
+    "name" : "my-route-table",
+    "description" : "rtb-for-a",
+    "is_default_association" : false,
+    "is_default_propagation" : false,
+    "state" : "available",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Route Tables
+
+
+ diff --git a/docs/er/api-ref/ShowStaticRoute.html b/docs/er/api-ref/ShowStaticRoute.html new file mode 100644 index 000000000..6b099677d --- /dev/null +++ b/docs/er/api-ref/ShowStaticRoute.html @@ -0,0 +1,237 @@ + + +

Querying Details About a Static Route

+

Function

This API is used to query details about a static route.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+

route_id

+

Yes

+

String

+

Route ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

route

+

Route object

+

Route

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Route

Parameter

+

Type

+

Description

+

id

+

String

+

Route ID

+

type

+

String

+

Route type. The value is static.

+

state

+

String

+

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

+

is_blackhole

+

Boolean

+

Whether the route is a blackhole route

+

destination

+

String

+

Destination address of the route

+

attachments

+

Array of RouteAttachment objects

+

Next hops

+

route_table_id

+

String

+

Route table ID

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 RouteAttachment

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Attached resource ID

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

attachment_id

+

String

+

Attachment ID

+
+
+
+

Example Requests

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/19d334b7-78c1-4e0e-ba29-b797e641e23c/static-routes/19d334b7-78c1-4e0e-ba29-b797e641e23c
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "route" : {
+    "id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
+    "type" : "static",
+    "destination" : "192.168.0.0/16",
+    "attachments" : [ {
+      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
+      "resource_type" : "VPC",
+      "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289"
+    } ],
+    "route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
+    "is_blackhole" : false,
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31",
+    "updated_at" : "2020-03-11T15:13:31"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Routes
+
+
+ diff --git a/docs/er/api-ref/ShowVpcAttachment.html b/docs/er/api-ref/ShowVpcAttachment.html new file mode 100644 index 000000000..35479b959 --- /dev/null +++ b/docs/er/api-ref/ShowVpcAttachment.html @@ -0,0 +1,258 @@ + + +

Querying Details About a VPC Attachment

+

Function

This API is used to query details about a VPC attachment.

+
+

URI

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

vpc_attachment_id

+

Yes

+

String

+

VPC attachment ID

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

vpc_attachment

+

VpcAttachmentDetails object

+

VPC attachment

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 VpcAttachmentDetails

Parameter

+

Type

+

Description

+

id

+

String

+

VPC attachment ID

+

name

+

String

+

VPC attachment name

+

vpc_id

+

String

+

VPC id

+

virsubnet_id

+

String

+

VPC subnet ID

+

auto_create_vpc_routes

+

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.

+

Default: false

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

description

+

String

+

Supplementary information about the VPC attachment

+

project_id

+

String

+

Project ID

+

vpc_project_id

+

String

+

ID of the project that the VPC belongs to

+

ipv6_enable

+

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.

+

Default: false

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

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Querying details about a VPC attachment

+
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/212d3f0b-8496-472d-bc99-05a7c96d6655/vpc-attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "vpc_attachment" : {
+    "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
+    "name" : "vpc-attach",
+    "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "ipv6_enable" : false,
+    "state" : "available",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: VPC Attachments
+
+
+ diff --git a/docs/er/api-ref/StateCode.html b/docs/er/api-ref/StateCode.html new file mode 100644 index 000000000..b1a42c295 --- /dev/null +++ b/docs/er/api-ref/StateCode.html @@ -0,0 +1,161 @@ + + +

Status Codes

+
+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Normal status codes

Status Code

+

Message

+

Description

+

200

+

OK

+

Normal response code for the GET, PUT, and POST operations

+

201

+

Created

+

Normal response code for POST operations

+

202

+

Accepted

+

Operations that take a long time to process.

+

The request has been accepted but the processing is not complete.

+

204

+

No Content

+

Normal response code for DELETE operations

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Abnormal status codes

Status Code

+

Message

+

Description

+

400

+

Bad Request

+

The server failed to process the request.

+

401

+

Unauthorized

+

You must enter a username and the password to access the requested page.

+

403

+

Forbidden

+

Access to the requested page is forbidden.

+

404

+

Not Found

+

The requested page was not found.

+

405

+

Method Not Allowed

+

The request method is not allowed.

+

406

+

Not Acceptable

+

Response generated by the server is not acceptable to the client.

+

407

+

Proxy Authentication Required

+

You must use the proxy server for authentication. Then, the request can be processed.

+

408

+

Request Timeout

+

The request timed out.

+

409

+

Conflict

+

The request could not be processed due to a conflict.

+

500

+

Internal Server Error

+

The request is not completed because an exception occurs.

+

501

+

Not Implemented

+

The request is not completed because the server does not support the requested function.

+

502

+

Bad Gateway

+

The request is not completed because the server receives an invalid response from the upstream server.

+

503

+

Service Unavailable

+

The request is not completed because the system is temporarily abnormal.

+

504

+

Gateway Timeout

+

The gateway timed out.

+
+
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/er/api-ref/Tags.html b/docs/er/api-ref/Tags.html new file mode 100644 index 000000000..4eef1112d --- /dev/null +++ b/docs/er/api-ref/Tags.html @@ -0,0 +1,22 @@ + + +

Tags

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/UpdateAttachment.html b/docs/er/api-ref/UpdateAttachment.html new file mode 100644 index 000000000..815511ccf --- /dev/null +++ b/docs/er/api-ref/UpdateAttachment.html @@ -0,0 +1,311 @@ + + +

Updating an Attachment

+

Function

This API is used to update basic information about an attachment.

+
+

URI

PUT /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

attachment_id

+

Yes

+

String

+

Attachment ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

attachment

+

No

+

UpdateAttachmentBody object

+

Change basic information about the attachment.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 UpdateAttachmentBody

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Supplementary information about the attachment. The value contains a maximum of 36 characters in UUID format with hyphens (-).

+

Minimum: 0

+

Maximum: 255

+

name

+

No

+

String

+

Attachment name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

+

Minimum: 1

+

Maximum: 64

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

attachment

+

AttachmentResponse object

+

Attachment basic information

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 AttachmentResponse

Parameter

+

Type

+

Description

+

name

+

String

+

Attachment name

+

id

+

String

+

Attachment ID

+

description

+

String

+

Supplementary information

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

tags

+

Array of Tag objects

+

Enterprise router tags

+

project_id

+

String

+

Project ID

+

resource_id

+

String

+

Attached resource ID on its own service console

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

resource_project_id

+

String

+

ID of the project that the resource belongs to

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 Tag

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Updating an attachment (not a VPC attachment)

+
PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/212d3f0b-8496-472d-bc99-05a7c96d6655/attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8
+
+{
+  "attachment" : {
+    "name" : "attachment",
+    "description" : "attachment"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "attachment" : {
+    "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
+    "name" : "attachment",
+    "description" : "attachment",
+    "state" : "avaliable",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "resource_type" : "vpc",
+    "resource_project_id" : "0605767a9980d5762fbcc00b3537e757"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Attachments
+
+
+ diff --git a/docs/er/api-ref/UpdateEnterpriseRouter.html b/docs/er/api-ref/UpdateEnterpriseRouter.html new file mode 100644 index 000000000..0a9cd5b48 --- /dev/null +++ b/docs/er/api-ref/UpdateEnterpriseRouter.html @@ -0,0 +1,401 @@ + + +

Updating an Enterprise Router

+

Function

This API is used to update basic information about the enterprise router.

+
+

Constraints

Information (except name and description) can be updated only when the enterprise router is in the available state.

+
+

URI

PUT /v3/{project_id}/enterprise-router/instances/{er_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instance

+

No

+

UpdateEnterpriseRouter object

+

Request body for updating an enterprise router

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 UpdateEnterpriseRouter

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Enterprise router name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Supplementary information about an enterprise router

+

Minimum: 0

+

Maximum: 255

+

enable_default_propagation

+

No

+

Boolean

+

Whether to enable Default Route Table Propagation.

+

enable_default_association

+

No

+

Boolean

+

Whether to enable Default Route Table Association.

+

default_propagation_route_table_id

+

No

+

String

+

Default propagation route table ID

+

default_association_route_table_id

+

No

+

String

+

Default association route table ID

+

auto_accept_shared_attachments

+

No

+

Boolean

+

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

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instance

+

EnterpriseRouter object

+

Enterprise router

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 EnterpriseRouter

Parameter

+

Type

+

Description

+

id

+

String

+

Enterprise router ID

+

name

+

String

+

Enterprise router name

+

description

+

String

+

Supplementary information about an enterprise router

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

charge_mode

+

String

+

Default: postPaid

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

enterprise_project_id

+

String

+

Enterprise project ID

+

project_id

+

String

+

Project ID

+

asn

+

Long

+

Enterprise router BGP ASN

+

enable_default_propagation

+

Boolean

+

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

+

enable_default_association

+

Boolean

+

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

+

default_propagation_route_table_id

+

String

+

Default propagation route table ID

+

default_association_route_table_id

+

String

+

Default association route table ID

+

availability_zone_ids

+

Array of strings

+

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

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 Tag

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Updating an enterprise router to enable Default Route Table Association and Default Route Table Propagation and specify route table

+
PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/94c2b814-99dc-939a-e811-ae84c61ea3ff
+
+{
+  "instance" : {
+    "enable_default_association" : true,
+    "enable_default_propagation" : true,
+    "default_propagation_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
+    "default_association_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "instance" : {
+    "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
+    "name" : "my_er",
+    "description" : "this is my first enterprise router",
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "state" : "pending",
+    "asn" : 64512,
+    "enable_default_association" : true,
+    "enable_default_propagation" : true,
+    "default_propagation_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
+    "default_association_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
+    "auto_accept_shared_attachments" : false,
+    "availability_zone_ids" : [ "az1" ],
+    "created_at" : "2019-09-06 02:11:13Z",
+    "updated_at" : "2019-09-06 02:11:13Z"
+  },
+  "request_id" : "14c2b814-99dc-939b-e81c-ae84c61ea3f7"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Enterprise Routers
+
+
+ diff --git a/docs/er/api-ref/UpdateFlowLog.html b/docs/er/api-ref/UpdateFlowLog.html new file mode 100644 index 000000000..03fc4c58a --- /dev/null +++ b/docs/er/api-ref/UpdateFlowLog.html @@ -0,0 +1,284 @@ + + +

Updating a Flow Log

+

Function

This API is used to update a flow log.

+
+

URI

PUT /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

flow_log_id

+

Yes

+

String

+

Flow log ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Flow log name

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Minimum: 0

+

Maximum: 255

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

flow_log

+

FlowLog object

+

Flow log details

+

request_id

+

String

+

Request ID

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

Parameter

+

Type

+

Description

+

id

+

String

+

Flow log ID

+

name

+

String

+

Flow log name

+

description

+

String

+

Flow log description

+

project_id

+

String

+

Project ID of the flow log task creator

+

resource_type

+

String

+

Resource type. The value is attachment.

+

resource_id

+

String

+

Resource ID

+

log_group_id

+

String

+

Log group ID

+

log_stream_id

+

String

+

Log stream ID

+

log_store_type

+

String

+

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

+

log_store_name

+

String

+

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

+

log_aggregation_interval

+

Integer

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

state

+

String

+

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

+

enabled

+

Boolean

+

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

+
+
+
+

Example Requests

Updating a flow log

+
PUT https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/flow_logs/b216bc1d-5963-41a7-89f9-779a5128c5ac
+
+{
+  "name" : "flow_log_update",
+  "description" : "flow log update test"
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "flow_log" : {
+    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
+    "name" : "flow_log_update",
+    "project_id" : "0605767a9980d5762fbcc00b3537e757",
+    "resource_type" : "attachment",
+    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
+    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
+    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
+    "log_store_type" : "LTS",
+    "log_aggregation_interval" : 600,
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2022-03-11T15:13:31Z",
+    "state" : "available",
+    "enabled" : true,
+    "description" : "flow log update test"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Flow Logs
+
+
+ diff --git a/docs/er/api-ref/UpdateRouteTable.html b/docs/er/api-ref/UpdateRouteTable.html new file mode 100644 index 000000000..b33b75a02 --- /dev/null +++ b/docs/er/api-ref/UpdateRouteTable.html @@ -0,0 +1,365 @@ + + +

Updating Route Table Information

+

Function

This API is used to update basic information about a route table, such as the name and description.

+
+

URI

PUT /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

route_table

+

No

+

UpdateRouteTable object

+

Request body for updating a route table

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 UpdateRouteTable

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Route table name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Supplementary information about the route table

+

Minimum: 0

+

Maximum: 255

+

bgp_options

+

No

+

BgpOptions object

+

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

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 BgpOptions

Parameter

+

Mandatory

+

Type

+

Description

+

load_balancing_as_path_ignore

+

No

+

Boolean

+

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

+

No

+

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.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

route_table

+

RouteTable object

+

Route table

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 RouteTable

Parameter

+

Type

+

Description

+

id

+

String

+

Route table ID

+

name

+

String

+

Route table name

+

description

+

String

+

Supplementary information

+

is_default_association

+

Boolean

+

Whether the route table is the default association route table.

+

Default: false

+

is_default_propagation

+

Boolean

+

Whether the route table is the default propagation route table.

+

state

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag

+

bgp_options

+

BgpOptions object

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 Tag

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 BgpOptions

Parameter

+

Type

+

Description

+

load_balancing_as_path_ignore

+

Boolean

+

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

+

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.

+
+
+
+

Example Requests

Changing the name of a route table of an enterprise router to new-rtb

+
PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f5/route-tables/4ab54142-7c92-48ad-8288-77727a231052
+
+{
+  "route_table" : {
+    "name" : "new-rtb"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "route_table" : {
+    "id" : "4ab54142-7c92-48ad-8288-77727a231052",
+    "name" : "new-rtb",
+    "is_default_association" : false,
+    "is_default_propagation" : false,
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Route Tables
+
+
+ diff --git a/docs/er/api-ref/UpdateStaticRoute.html b/docs/er/api-ref/UpdateStaticRoute.html new file mode 100644 index 000000000..eada66896 --- /dev/null +++ b/docs/er/api-ref/UpdateStaticRoute.html @@ -0,0 +1,301 @@ + + +

Updating a Static Route

+

Function

This API is used to update a static route.

+
+

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

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

route_table_id

+

Yes

+

String

+

Route table ID

+

route_id

+

Yes

+

String

+

Route ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

route

+

Yes

+

UpdateRoute object

+

Route

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 UpdateRoute

Parameter

+

Mandatory

+

Type

+

Description

+

attachment_id

+

No

+

String

+

Next hop of the route

+

is_blackhole

+

No

+

Boolean

+

Whether the route is a blackhole route

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

route

+

Route object

+

Route

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Route

Parameter

+

Type

+

Description

+

id

+

String

+

Route ID

+

type

+

String

+

Route type. The value is static.

+

state

+

String

+

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

+

is_blackhole

+

Boolean

+

Whether the route is a blackhole route

+

destination

+

String

+

Destination address of the route

+

attachments

+

Array of RouteAttachment objects

+

Next hops

+

route_table_id

+

String

+

Route table ID

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 RouteAttachment

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Attached resource ID

+

resource_type

+

String

+

Attachment type.

+

  • vpc: VPC attachments

    +

  • vgw: virtual gateway attachments

    +
+

attachment_id

+

String

+

Attachment ID

+
+
+
+

Example Requests

Modifying a static route

+
PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/19d334b7-78c1-4e0e-ba29-b797e641e23c/static-routes/9b3b38a9-1c9d-4f01-9429-81af6b545289
+
+{
+  "route" : {
+    "is_blackhole" : false,
+    "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
+  }
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "route" : {
+    "id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
+    "type" : "static",
+    "destination" : "192.168.0.0/16",
+    "attachments" : [ {
+      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
+      "resource_type" : "vpc",
+      "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
+    } ],
+    "route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
+    "is_blackhole" : false,
+    "state" : "pending",
+    "created_at" : "2020-03-11T15:13:31",
+    "updated_at" : "2020-03-11T15:13:31"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

202

+

Accepted

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Routes
+
+
+ diff --git a/docs/er/api-ref/UpdateVpcAttachment.html b/docs/er/api-ref/UpdateVpcAttachment.html new file mode 100644 index 000000000..991d43b39 --- /dev/null +++ b/docs/er/api-ref/UpdateVpcAttachment.html @@ -0,0 +1,323 @@ + + +

Updating a VPC Attachment

+

Function

This API is used to update basic information about a VPC attachment.

+
+

URI

PUT /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

er_id

+

Yes

+

String

+

Enterprise router ID

+

vpc_attachment_id

+

Yes

+

String

+

VPC attachment ID

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

vpc_attachment

+

No

+

UpdateVpcAttachmentBody object

+

Request body for updating VPC information

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 UpdateVpcAttachmentBody

Parameter

+

Mandatory

+

Type

+

Description

+

description

+

No

+

String

+

Supplementary information about the VPC attachment. The value contains a maximum of 36 characters in UUID format with hyphens (-).

+

Minimum: 0

+

Maximum: 255

+

name

+

No

+

String

+

VPC attachment name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

+

Minimum: 1

+

Maximum: 64

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

vpc_attachment

+

VpcAttachmentDetails object

+

VPC attachment

+

request_id

+

String

+

Request ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 VpcAttachmentDetails

Parameter

+

Type

+

Description

+

id

+

String

+

VPC attachment ID

+

name

+

String

+

VPC attachment name

+

vpc_id

+

String

+

VPC id

+

virsubnet_id

+

String

+

VPC subnet ID

+

auto_create_vpc_routes

+

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.

+

Default: false

+

state

+

String

+

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

+

created_at

+

String

+

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

+

updated_at

+

String

+

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

+

tags

+

Array of Tag objects

+

Tag information

+

description

+

String

+

Supplementary information about the VPC attachment

+

project_id

+

String

+

Project ID

+

vpc_project_id

+

String

+

ID of the project that the VPC belongs to

+

ipv6_enable

+

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.

+

Default: false

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 Tag

Parameter

+

Type

+

Description

+

key

+

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

+

value

+

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

+
+
+
+

Example Requests

Updating a VPC attachment (changing its name to new-vpc-attach)

+
PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/f1a28dfd-186f-4625-b6b1-f05e5e8609c0/vpc-attachments/3b9724e9-49ec-4d21-9191-3d703133b910
+
+{
+  "vpc_attachment" : {
+    "name" : "new-vpc-attach"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "vpc_attachment" : {
+    "id" : "3b9724e9-49ec-4d21-9191-3d703133b910",
+    "name" : "new-vpc-attach",
+    "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
+    "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
+    "auto_create_vpc_routes" : false,
+    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
+    "ipv6_enable" : false,
+    "state" : "available",
+    "created_at" : "2020-03-11T15:13:31Z",
+    "updated_at" : "2020-03-11T15:13:31Z"
+  },
+  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

OK

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: VPC Attachments
+
+
+ diff --git a/docs/er/api-ref/VPCAttachment.html b/docs/er/api-ref/VPCAttachment.html new file mode 100644 index 000000000..c8e6963fd --- /dev/null +++ b/docs/er/api-ref/VPCAttachment.html @@ -0,0 +1,24 @@ + + +

VPC Attachments

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/en-us_image_0000001294957952.png b/docs/er/api-ref/en-us_image_0000001294957952.png new file mode 100644 index 000000000..cf8537929 Binary files /dev/null and b/docs/er/api-ref/en-us_image_0000001294957952.png differ diff --git a/docs/er/api-ref/er_02_0001.html b/docs/er/api-ref/er_02_0001.html new file mode 100644 index 000000000..56ce72624 --- /dev/null +++ b/docs/er/api-ref/er_02_0001.html @@ -0,0 +1,48 @@ + + +

API Usage Guidelines

+

Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
Network instances can be attached to an enterprise router as its attachments. The attachment type varies depending on the network instance.
Figure 1 Attachments
+ +
+ + + + + + + + + + + + + + + + + + + +
Table 1 Enterprise Router attachments

Attachment Type

+

Network Instance

+

Creating an Attachment

+

Querying Attachment Details

+

Deleting an Attachment

+

VPC attachment

+

VPC

+

Creating a VPC Attachment

+

Querying Details About a VPC Attachment

+

Deleting a VPC Attachment

+

Virtual gateway attachment

+

Virtual gateway of Direct Connect

+

Create a virtual gateway by referring to Creating a Virtual Gateway and then attach it to an enterprise router.

+

Querying Details About an Attachment

+

Deleting a Virtual Gateway

+
+
+
+
+ diff --git a/docs/er/api-ref/er_02_0014.html b/docs/er/api-ref/er_02_0014.html new file mode 100644 index 000000000..d28a2904c --- /dev/null +++ b/docs/er/api-ref/er_02_0014.html @@ -0,0 +1,37 @@ + + + +

APIs

+ +

+
+ +
+ +
+ diff --git a/docs/er/api-ref/er_02_0015.html b/docs/er/api-ref/er_02_0015.html new file mode 100644 index 000000000..929a4bdc8 --- /dev/null +++ b/docs/er/api-ref/er_02_0015.html @@ -0,0 +1,35 @@ + + + +

Permissions Policies and Supported Actions

+ +

+
+ +
+ +
+ diff --git a/docs/er/api-ref/er_02_0016.html b/docs/er/api-ref/er_02_0016.html new file mode 100644 index 000000000..fd2b022a1 --- /dev/null +++ b/docs/er/api-ref/er_02_0016.html @@ -0,0 +1,18 @@ + + +

Introduction

+

This section describes fine-grained permissions management for your Enterprise Router resources. If your account does not need individual IAM users, you may skip this section.

+

By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign policies or roles to these groups. The user then inherits permissions from the groups. After authorization, the user can perform specified operations on cloud services based on the permissions.

+

An account has all of the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions can call the API successfully. For example, if an IAM user wants to query enterprise routers using an API, the user must have been granted permissions that allow the er:instances:list action.

+

Supported Actions

IAM provides system-defined policies that can be directly used. You can also create custom policies to work with system-defined policies for more refined access control. Actions supported by policies are specific to APIs. Common concepts related to policies include:

+ +
Enterprise Router supports the following actions that can be defined in custom policies: +
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0017.html b/docs/er/api-ref/er_02_0017.html new file mode 100644 index 000000000..56257faff --- /dev/null +++ b/docs/er/api-ref/er_02_0017.html @@ -0,0 +1,81 @@ + + +

Enterprise Routers

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating an enterprise router

+

POST /v3/{project_id}/enterprise-router/instances

+

er:instances:create

+

√

+

√

+

Updating an enterprise router

+

PUT /v3/{project_id}/enterprise-router/instances/{enterprise_router_id}

+

er:instances:update

+

√

+

√

+

Querying details about an enterprise router

+

GET /v3/{project_id}/enterprise-router/instances/{enterprise_router_id}

+

er:instances:get

+

√

+

√

+

Querying the enterprise router list

+

GET /v3/{project_id}/enterprise-router/instances

+

er:instances:list

+

√

+

√

+

Deleting an enterprise router

+

DELETE /v3/{project_id}/enterprise-router/instances/{enterprise_router_id}

+

er:instances:delete

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0018.html b/docs/er/api-ref/er_02_0018.html new file mode 100644 index 000000000..63c183386 --- /dev/null +++ b/docs/er/api-ref/er_02_0018.html @@ -0,0 +1,81 @@ + + +

VPC Attachments

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

Project

+

Enterprise Project

+

Creating a VPC attachment

+

POST /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments

+

er:attachments:create

+

√

+

√

+

Updating a VPC attachment

+

PUT /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}

+

er:attachments:update

+

√

+

√

+

Querying details about a VPC attachment

+

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

+

er:attachments:get

+

√

+

√

+

Querying the VPC attachment list

+

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

+

er:attachments:list

+

√

+

√

+

Deleting a VPC attachment

+

DELETE /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}

+

er:attachments:delete

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0019.html b/docs/er/api-ref/er_02_0019.html new file mode 100644 index 000000000..cec98b2ab --- /dev/null +++ b/docs/er/api-ref/er_02_0019.html @@ -0,0 +1,59 @@ + + +

Attachments

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Updating an attachment

+

PUT /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}

+

er:attachments:update

+

√

+

√

+

Querying details about an attachment

+

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

+

er:attachments:get

+

√

+

√

+

Querying the attachment list

+

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

+

er:attachments:list

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0020.html b/docs/er/api-ref/er_02_0020.html new file mode 100644 index 000000000..319e2a584 --- /dev/null +++ b/docs/er/api-ref/er_02_0020.html @@ -0,0 +1,81 @@ + + +

Route Tables

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a route table

+

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables

+

er:routeTables:create

+

√

+

√

+

Updating a route table

+

PUT /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}

+

er:routeTables:update

+

√

+

√

+

Querying details about a route table

+

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

+

er:routeTables:get

+

√

+

√

+

Querying the route table list

+

GET /v3/{project_id}/enterprise-router/{er_id}/route-tables

+

er:routeTables:list

+

√

+

√

+

Deleting a route table

+

DELETE /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}

+

er:routeTables:delete

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0021.html b/docs/er/api-ref/er_02_0021.html new file mode 100644 index 000000000..44236223c --- /dev/null +++ b/docs/er/api-ref/er_02_0021.html @@ -0,0 +1,59 @@ + + +

Associations

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating an association

+

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associate

+

er:associations:associate

+

√

+

√

+

Querying the association list

+

GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associations

+

er:associations:list

+

√

+

√

+

Deleting an association

+

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disassociate

+

er:associations:disassociate

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0022.html b/docs/er/api-ref/er_02_0022.html new file mode 100644 index 000000000..2fdcea847 --- /dev/null +++ b/docs/er/api-ref/er_02_0022.html @@ -0,0 +1,59 @@ + + +

Propagations

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a propagation

+

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/enable-propagations

+

er:propagations:enable

+

√

+

√

+

Querying the propagation list

+

GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations

+

er:propagations:list

+

√

+

√

+

Deleting a propagation

+

POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disable-propagations

+

er:propagations:disable

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0023.html b/docs/er/api-ref/er_02_0023.html new file mode 100644 index 000000000..137bb00db --- /dev/null +++ b/docs/er/api-ref/er_02_0023.html @@ -0,0 +1,92 @@ + + +

Routes

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a static route

+

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

+

er:routes:create

+

√

+

√

+

Updating a static route

+

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

+

er:routes:update

+

√

+

√

+

Querying details about a static route

+

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

+

er:routes:get

+

√

+

√

+

Querying static routes

+

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

+

er:routes:list

+

√

+

√

+

Querying effective routes

+

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

+

er:routes:list

+

√

+

√

+

Deleting a static route

+

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

+

er:routes:delete

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0024.html b/docs/er/api-ref/er_02_0024.html new file mode 100644 index 000000000..6edfaf2d5 --- /dev/null +++ b/docs/er/api-ref/er_02_0024.html @@ -0,0 +1,103 @@ + + +

Flow Logs

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Creating a flow log

+

POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs

+

er:flowlogs:create

+

√

+

√

+

Querying the flow log list

+

GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs

+

er:flowlogs:list

+

√

+

√

+

Querying details about a flow log

+

GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}

+

er:flowlogs:show

+

√

+

√

+

Updating a flow log

+

PUT /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}

+

er:flowlogs:update

+

√

+

√

+

Deleting a flow log

+

DELETE /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}

+

er:flowlogs:delete

+

√

+

√

+

Enabling flow logging

+

POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/enable

+

er:flowlogs:enable

+

√

+

√

+

Disabling flow logging

+

POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/disable

+

er:flowlogs:disable

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0033.html b/docs/er/api-ref/er_02_0033.html new file mode 100644 index 000000000..0acf0e2ca --- /dev/null +++ b/docs/er/api-ref/er_02_0033.html @@ -0,0 +1,81 @@ + + +

Tags

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying tags by resource type

+

GET /v3/{project_id}/{resource_type}/tags

+

er:tags:list

+

√

+

√

+

Querying resource tags

+

GET /v3/{project_id}/{resource_type}/{resource_id}/tags

+

er:tags:get

+

√

+

√

+

Creating a resource tag

+

POST /v3/{project_id}/{resource_type}/{resource_id}/tags

+

er:tags:create

+

√

+

√

+

Adding or deleting resource tags in batches

+

POST /v3/{project_id}/{resource_type}/{resource_id}/tags/action

+

er:tags:create

+

√

+

√

+

Deleting a resource tag

+

POST /v3/{project_id}/{resource_type}/{resource_id}/tags/{key}

+

er:tags:delete

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0034.html b/docs/er/api-ref/er_02_0034.html new file mode 100644 index 000000000..d331ef2bc --- /dev/null +++ b/docs/er/api-ref/er_02_0034.html @@ -0,0 +1,37 @@ + + +

Quota Management

+
+
+ + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying quotas

+

GET /v3/{project_id}/enterprise-router/quotas

+

er:quotas:list

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/er/api-ref/er_02_0035.html b/docs/er/api-ref/er_02_0035.html new file mode 100644 index 000000000..9d3515691 --- /dev/null +++ b/docs/er/api-ref/er_02_0035.html @@ -0,0 +1,15 @@ + + +

Sharing

+
You can share an enterprise router in your account with other accounts. +
+

After you share your enterprise router with other accounts, these other users can attach their network instances to your enterprise router, so that their network instances can access your enterprise router.

+

Enterprise routers cannot be shared through APIs. You can only use this function on the management console. For details, see section "Sharing Overview" in the Enterprise Router User Guide.

+
+
+
+
+
Parent topic: APIs
+
+
+ diff --git a/docs/er/api-ref/er_02_appendix.html b/docs/er/api-ref/er_02_appendix.html new file mode 100644 index 000000000..ffdde1923 --- /dev/null +++ b/docs/er/api-ref/er_02_appendix.html @@ -0,0 +1,17 @@ + + + +

Appendixes

+ +

+
+ +
+ +
+ diff --git a/docs/er/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/er/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/er/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/er/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/er/api-ref/public_sys-resources/delta.gif b/docs/er/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/er/api-ref/public_sys-resources/deltaend.gif b/docs/er/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/er/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..379428032 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/er/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..6aaaa11c2 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-caution.gif b/docs/er/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-danger.gif b/docs/er/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-huawei.gif b/docs/er/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-note.gif b/docs/er/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-notice.gif b/docs/er/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-tip.gif b/docs/er/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/er/api-ref/public_sys-resources/icon-warning.gif b/docs/er/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/er/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/er/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/er/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/er/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/er/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/er/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/er/api-ref/public_sys-resources/warning_3.0-en-us.png differ