dadrobna/enterprise-router
1
0
Fork 0
forked from docs/enterprise-router
Code Pull Requests Activity

Changes to er_api-ref from docs/doc-exports#1049 (ER API 20240206 version

Browse Source 
For d

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
proposalbot 2024-03-05 14:54:24 +00:00 committed by zuul
parent 5b1d5d43ce
commit 47d598aed2
4 changed files with 88 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst
View File

@ -50,47 +50,47 @@ Request Parameters
.. table:: **Table 4** CreateEnterpriseRouter .. table:: **Table 4** CreateEnterpriseRouter
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | 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 (.). | | name | Yes | String | Enterprise router name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
| | | | | | | | | |
| | | | Minimum: **1** | | | | | Minimum: **1** |
| | | | | | | | | |
| | | | Maximum: **64** | | | | | Maximum: **64** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Supplementary information about an enterprise router | | description | No | String | Supplementary information about an enterprise router |
| | | | | | | | | |
| | | | Minimum: **0** | | | | | Minimum: **0** |
| | | | | | | | | |
| | | | Maximum: **255** | | | | | Maximum: **255** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| asn | Yes | Long | Enterprise router BGP ASN | | asn | Yes | Long | Enterprise router BGP ASN. Specify a dedicated ASN in the range of 64512-65534 or 4200000000-4294967294. ASN can only be set during enterprise router creation. |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | Enterprise project ID | | enterprise_project_id | No | String | Enterprise project ID |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | No | String | Default: **postPaid** | | charge_mode | No | String | Default: **postPaid** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | No | Array of :ref:`Tag <createenterpriserouter__request_tag>` objects | Tag information | | tags | No | Array of :ref:`Tag <createenterpriserouter__request_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. | | 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** | | | | | 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. | | 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** | | | | | Default: **false** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Yes | Array of strings | AZs where the enterprise router is located | | availability_zone_ids | Yes | Array of strings | AZs where the enterprise router is located |
| | | | | | | | | |
| | | | Minimum: **0** | | | | | Minimum: **0** |
| | | | | | | | | |
| | | | Maximum: **128** | | | | | 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. | | 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** | | | | | Default: **false** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_blocks | No | Array of strings | Enterprise router CIDR block. This parameter is not supported for now. | | cidr_blocks | No | Array of strings | Enterprise router CIDR block. This parameter is not supported for now. |
| | | | | | | | | |
| | | | Minimum: **1** | | | | | Minimum: **1** |
@ -98,7 +98,7 @@ Request Parameters
| | | | Maximum: **64** | | | | | Maximum: **64** |
| | | | | | | | | |
| | | | Array Length: **0 - 100** | | | | | Array Length: **0 - 100** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------------------+-----------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _createenterpriserouter__request_tag: .. _createenterpriserouter__request_tag:

20
api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst
View File

@ -51,35 +51,35 @@ Request Parameters
.. table:: **Table 4** VpcAttachmentCreateRequest .. table:: **Table 4** VpcAttachmentCreateRequest
+------------------------+-----------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+========================+=================+================================================================+=========================================================================================================================================================================+ +========================+=================+================================================================+==============================================================================================================================================================================================================================================+
| vpc_id | Yes | String | VPC ID. The value contains a maximum of 36 characters in UUID format with hyphens (-). | | 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 (.). | | name | Yes | String | VPC attachment name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
| | | | | | | | | |
| | | | Minimum: **1** | | | | | Minimum: **1** |
| | | | | | | | | |
| | | | Maximum: **64** | | | | | Maximum: **64** |
+------------------------+-----------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virsubnet_id | Yes | String | VPC subnet ID. The value contains a maximum of 36 characters in UUID format with hyphens (-). | | 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 >). | | description | No | String | Supplementary information. The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
| | | | | | | | | |
| | | | Minimum: **0** | | | | | Minimum: **0** |
| | | | | | | | | |
| | | | Maximum: **255** | | | | | 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. | | 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. This parameter can only be enabled when a VPC attachment is created. |
| | | | | | | | | |
| | | | Default: **false** | | | | | 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. | | 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** | | | | | Default: **false** |
+------------------------+-----------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | No | Array of :ref:`Tag <createvpcattachment__request_tag>` objects | Tag information | | tags | No | Array of :ref:`Tag <createvpcattachment__request_tag>` objects | Tag information |
+------------------------+-----------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _createvpcattachment__request_tag: .. _createvpcattachment__request_tag:

8
api-ref/source/change_history.rst
View File

@ -8,6 +8,14 @@ Change History
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description | | Released On | Description |
+===================================+================================================================================================================================================================================+ +===================================+================================================================================================================================================================================+
| 2024-03-05 | This release incorporates the following changes: |
| | |
| | Modified the description of the **asn** parameter in "Creating an Enterprise Router". |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2024-02-05 | This release incorporates the following changes: |
| | |
| | Modified the description of the **auto_create_vpc_routes** parameter in "Creating a VPC Attachment." |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-12-06 | This release incorporates the following changes: | | 2023-12-06 | This release incorporates the following changes: |
| | | | | |
| | - Modified the descriptions of the tag key and value in the document. | | | - Modified the descriptions of the tag key and value in the document. |

4
api-ref/source/permissions_policies_and_supported_actions/introduction.rst
View File

@ -5,11 +5,11 @@
Introduction 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. This topic describes fine-grained permissions management for your Enterprise Router resources. If your account does not need individual IAM users, you may skip this topic.
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. 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. 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 the enterprise router list using an API, the user must have been granted permissions that allow the **er:instances:list** action.
Supported Actions Supported Actions
----------------- -----------------