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 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 and responses are transmitted using JSON messages, with media type represented by Application/json.
For details about how to use APIs, see API Usage Guidelines.
API Overview
+APIs provided by the EIP service include native OpenStack APIs and EIP APIs.
+A combination of these two types of APIs allows you to use all functions provided by the EIP service.
+Enterprise project users can only use EIP APIs. For details about API permissions, see Permissions Policies and Supported Actions.
+ +Type + |
+Subtype + |
+Description + |
+
|---|---|---|
EIP API + |
+EIP + |
+APIs for assigning, querying, updating, and releasing EIPs + |
+
EIP API + |
+Floating IP address (IPv6) + |
+APIs for assigning, querying, updating, and releasing IPv6 floating IP addresses + |
+
EIP API + |
+Bandwidth + |
+APIs for querying and updating bandwidth + |
+
EIP API + |
+Bandwidth (v2.0) + |
+
|
+
EIP API + |
+Quota + |
+API for querying quota values + |
+
EIP API + |
+EIP tag management + |
+APIs for adding tags to EIPs as well as querying and deleting EIP tags + |
+
OpenStack Neutron API + |
+Floating IP address + |
+APIs for assigning, querying, updating, and releasing floating IP addresses + |
+
OpenStack Neutron API + |
+API version + |
+APIs for querying all available API versions and displaying the results in pages. + |
+
EIP v3 API + |
+EIP (v3) + |
+APIs for binding and unbinding EIPs. + |
+
-
-
- Elastic IP
+ - EIP
- Floating IP Address (IPv6)
diff --git a/docs/eip/api-ref/eip_api05_0001.html b/docs/eip/api-ref/eip_api05_0001.html
index e9561a9c..755c26c2 100644
--- a/docs/eip/api-ref/eip_api05_0001.html
+++ b/docs/eip/api-ref/eip_api05_0001.html
@@ -37,7 +37,7 @@
- Status Codes
- - Error Codes
+ - Error Codes
diff --git a/docs/eip/api-ref/eip_api06_0003.html b/docs/eip/api-ref/eip_api06_0003.html
index 8ee81851..01ef4a56 100644
--- a/docs/eip/api-ref/eip_api06_0003.html
+++ b/docs/eip/api-ref/eip_api06_0003.html
@@ -3,7 +3,7 @@
- Added floating IP address (IPv6) API in Floating IP Address (IPv6).
- Added the floating IP address (IPv6) subtype in API Overview.
- Added the ip_version field in Assigning an EIP.
- Added the bandwidth (V2.0) subtype in API Overview.
- Modified the content related to status codes in Binding an EIP and Unbinding an EIP.
- Deleted section "Floating IP Address (IPv6)".
- Deleted the IPv6 field from Binding an EIP and Unbinding an EIP.
- Added 5_gray to the value range of parameter type in sections Assigning an EIP, Querying an EIP, Querying EIPs, and Updating an EIP.
- Added 5_gray to the value range of parameter publicip_type and gray for parameter bandwidth_type in sections Querying a Bandwidth and Querying Bandwidths.
- Added 5_gray to the value range of parameter publicip_type in sections Updating a Bandwidth, Assigning a Shared Bandwidth, and Adding an EIP to a Shared Bandwidth.
- Added 5_gray to the value range of parameter type in Assigning an EIP.
- Added 5_gray to the value range of parameter publicip_type and gray for parameter bandwidth_type in sections Querying a Bandwidth and Querying Bandwidths.
- Added 5_gray to the value range of parameter publicip_type in sections Updating a Bandwidth, Assigning a Shared Bandwidth, and Adding an EIP to a Shared Bandwidth.
- Modified the description about parameter updated_at and added parameters billing_info and enterprise_project_id in Bandwidth and Bandwidth (V2.0).
- Changed the value range of type in Querying the Quota.
- Added parameter enterprise_project_id to section Elastic IP.
- Added description "The value of port_id is null if the EIP is bound to a dedicated load balancer." to sections Querying an EIP, Querying EIPs, Querying Floating IP Addresses, and Querying a Floating IP Address.
- Added description "This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer." to sections Updating an EIP and Updating a Floating IP Address.
- Modified the description about parameter updated_at and added parameters billing_info and enterprise_project_id in Bandwidth and Bandwidth (V2.0).
- Changed the value range of type in Querying the Quota.
- Added parameter enterprise_project_id to EIP.
- Added description "The value of port_id is null if the EIP is bound to a dedicated load balancer." to Querying Floating IP Addresses and Querying a Floating IP Address.
- Added description "This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer." to Updating a Floating IP Address.
- Added parameter profile to sections Querying an EIP, Querying EIPs, and Updating an EIP.
- Changed the value range of the size parameter to 1 Mbit/s to 1000 Mbit/s in Querying Bandwidths, Updating a Bandwidth, and Removing an EIP from a Shared Bandwidth.
- Changed the value range of the size parameter to 5 Mbit/s to 1000 Mbit/s in Assigning a Shared Bandwidth and Adding an EIP to a Shared Bandwidth.
- Updated response examples in sections Querying a Bandwidth, Querying Bandwidths, Updating a Bandwidth, Assigning a Shared Bandwidth, and Adding an EIP to a Shared Bandwidth.
- Changed the value range of the size parameter to 1 Mbit/s to 1000 Mbit/s in Querying Bandwidths, Updating a Bandwidth, and Removing an EIP from a Shared Bandwidth.
- Changed the value range of the size parameter to 5 Mbit/s to 1000 Mbit/s in Assigning a Shared Bandwidth and Adding an EIP to a Shared Bandwidth.
- Updated response examples in sections Querying a Bandwidth, Querying Bandwidths, Updating a Bandwidth, Assigning a Shared Bandwidth, and Adding an EIP to a Shared Bandwidth.
- Added parameter id to the bandwidth field in section Assigning an EIP.
- Added parameter ip_version to sections Elastic IP, Bandwidth, and Bandwidth (V2.0).
- Added parameter bandwidth_name to section Elastic IP.
- Deleted description about IP address version conversion from section Updating an EIP.
- Added parameters created_at and updated_at in sections Bandwidth and Assigning a Shared Bandwidth.
- Added value share to the value range of parameter bandwidth_type in section Bandwidth.
- Added parameter id to the bandwidth field in section Assigning an EIP.
- Added parameter ip_version to sections EIP, Bandwidth, and Bandwidth (V2.0).
- Added parameter bandwidth_name to section EIP.
- Added parameters created_at and updated_at in sections Bandwidth and Assigning a Shared Bandwidth.
- Added value share to the value range of parameter bandwidth_type in section Bandwidth.
- Moved Error Codes and Status Codes to Appendix.
- Added a value for the type parameter of the publicip field in sections Elastic IP and Bandwidth.
- Added WHOLE to the value range of parameter share_type in section Bandwidth.
- Moved Error Codes and Status Codes to Appendix.
- Added a value for the type parameter of the publicip field in sections EIP and Bandwidth.
- Added WHOLE to the value range of parameter share_type in section Bandwidth.
- Added section Quota.
- Adjusted the table in section Permissions Policies and Supported Actions.
- Added fields dns_name and dns_domain to the example response to sections Querying Floating IP Addresses, Querying a Floating IP Address, Assigning a Floating IP Address, and Updating a Floating IP Address.
- Added parameters limit, marker, and page_reverse in section Querying Floating IP Addresses.
- Added parameter project_id in sections Querying Floating IP Addresses and Querying a Floating IP Address.
- Deleted parameters created_at and updated_at in sections Assigning a Floating IP Address and Updating a Floating IP Address.
- Modified request examples and response examples in sections Elastic IP, Bandwidth, Bandwidth (V2.0), and EIP Tag Management.
- Modified API restrictions in section Updating a Floating IP Address.
- Changed the maximum number of tags in section Querying EIPs by Tag.
- Added section Quota.
- Adjusted the table in section Permissions Policies and Supported Actions.
- Added fields dns_name and dns_domain to the example response to sections Querying Floating IP Addresses, Querying a Floating IP Address, Assigning a Floating IP Address, and Updating a Floating IP Address.
- Added parameters limit, marker, and page_reverse in section Querying Floating IP Addresses.
- Added parameter project_id in sections Querying Floating IP Addresses and Querying a Floating IP Address.
- Deleted parameters created_at and updated_at in sections Assigning a Floating IP Address and Updating a Floating IP Address.
- Modified request examples and response examples in sections EIP, Bandwidth, Bandwidth (V2.0), and EIP Tag Management.
- Modified API restrictions in section Updating a Floating IP Address.
- Changed the maximum number of tags in section Querying EIPs by Tag.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Request parameter
+-
Table 1 Request parameters Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Specifies the project ID.
+Specifies the project ID.
marker
+marker
No
+No
String
+String
Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.
+Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.
This parameter can work together with the parameter limit.
-- If parameters marker and limit are not passed, all resource records will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
- If parameters marker and limit are not passed, resource records on the first page will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
limit
+limit
No
+No
Integer
+Integer
Specifies the number of records that will be returned on each page. The value is from 0 to intmax.
+Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.
limit can be used together with marker. For details, see the parameter description of marker.
enterprise_project_id
+enterprise_project_id
No
+No
String
+String
- Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps.
- Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps.
NOTE:This parameter is unsupported. Do not use it.
- Possible values are as follows:
- PER: Dedicated bandwidth
- WHOLE: Shared bandwidth
- Possible values are as follows:
- PER: Dedicated bandwidth
- WHOLE: Shared bandwidth
If this parameter is not set, the list of all bandwidths will be returned by default.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the bandwidth size in Mbit/s.
- The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) If the parameter is not included, the bandwidth size is not changed.
- Either parameter name or size must be specified.
- If a decimal fraction (for example 10.2) or a character string (for example "10") is specified, the specified value will be automatically converted to an integer.
- The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
- The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
- The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
- The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
- Specifies the bandwidth size in Mbit/s.
- The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) If the parameter is not included, the bandwidth size is not changed.
- Either parameter name or size must be specified.
- If a decimal fraction (for example 10.2) or a character string (for example "10") is specified, the specified value will be automatically converted to an integer.
- The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
- The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
- The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
- The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
- Specifies the time (UTC) when the bandwidth is created.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the time (UTC) when the bandwidth is created.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the time (UTC) when the bandwidth is updated.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the time (UTC) when the bandwidth is updated.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the IP address version.
- Possible values are as follows:
- 4: IPv4
- 6: IPv6 (IPv6 is not supported currently.)
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
- Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
- Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
- Request parameter
-
Table 2 Request parameter Name
+Request Parameters
+Table 2 Request body parameter Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
publicip
+publicip
Yes
+Yes
publicip object
+publicip object
Specifies the EIP object. For details, see Table 3.
+Specifies the EIP object. For details, see Table 3.
bandwidth
+bandwidth
Yes
+Yes
bandwidth object
+bandwidth object
Specifies the bandwidth object. For details, see Table 4.
+Specifies the bandwidth object. For details, see Table 4.
enterprise_project_id
+enterprise_project_id
No
+No
String
+String
- Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
- When you assign an EIP, associate an enterprise project ID with the EIP.
- If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
- Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
- When you assign an EIP, associate an enterprise project ID with the EIP.
- If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
NOTE:This parameter is unsupported. Do not use it.
-Table 3 Description of the publicip field Name
+Table 3 Description of the publicip field Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
type
+type
Yes
+Yes
String
+String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
ip_address
+ip_version
No
+No
String
+Integer
- Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it.
- The value must be a valid IPv4 address in the available IP address range.
- Specifies the EIP version.
- The value can be 4 and 6, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently.
- Constraints:
- The configured value must be supported by the system.
- If this parameter is left blank or is an empty string, IPv4 address is created by default.
-Table 6 Description of the publicip field Name
+-Table 6 Description of the publicip field Name
Type
String
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- ERROR (Exceptions)
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- NOTIFYING (Assigning)
- NOTIFY_DELETE (Release)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- VPN (Bound to a VPN)
- ERROR (Exceptions)
String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_api_0002.html b/docs/eip/api-ref/eip_api_0002.html index cb073897..95697787 100644 --- a/docs/eip/api-ref/eip_api_0002.html +++ b/docs/eip/api-ref/eip_api_0002.html @@ -2,6 +2,10 @@-Parent topic: Elastic IP+Parent topic: EIPQuerying an EIP
-Function
This API is used to query a specific EIP.
+
Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:+- In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
- Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
- Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
Table 3 Description of the publicip field Name
+-Table 3 Description of the publicip field Name
Type
String
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- ERROR (Exceptions)
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- NOTIFYING (Assigning)
- NOTIFY_DELETE (Releasing)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- VPN (Bound to a VPN)
- ERROR (Exceptions)
profile object
Specifies the additional parameters, including the order ID and product ID. For details, see Table 4.
+This parameter is not supported currently.
type
String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_api_0003.html b/docs/eip/api-ref/eip_api_0003.html index aa9b700d..58922528 100644 --- a/docs/eip/api-ref/eip_api_0003.html +++ b/docs/eip/api-ref/eip_api_0003.html @@ -2,6 +2,10 @@-Parent topic: Elastic IP+Parent topic: EIPQuerying EIPs
-Function
This API is used to query EIPs.
+ Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:+- In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
- Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
- Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
URI
GET /v1/{project_id}/publicips
Table 1 describes the parameters. @@ -32,7 +36,7 @@Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.
This parameter can work together with the parameter limit.
-- If parameters marker and limit are not passed, all resource records will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
- If parameters marker and limit are not passed, resource records on the first page will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
limit
@@ -41,7 +45,7 @@Integer
Specifies the number of records that will be returned on each page. The value is from 0 to intmax.
+Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.
limit can be used together with marker. For details, see the parameter description of marker.
Table 3 Description of the publicips field Name
+-Table 3 Description of the publicips field Name
Type
Object
Specifies the additional parameters, including the order ID and product ID. For details, see Table 4.
+This parameter is not supported currently.
type
String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
Integer
Specifies the IP address version. The value can be 4 or 6.
-- 4: IPv4
- 6: IPv6 (IPv6 is not supported currently.)
- 4: IPv4
- 6: IPv6 (IPv6 is not supported currently.)
private_ip_address
@@ -291,12 +296,12 @@-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_api_0004.html b/docs/eip/api-ref/eip_api_0004.html index 4afb4d2d..f90176b6 100644 --- a/docs/eip/api-ref/eip_api_0004.html +++ b/docs/eip/api-ref/eip_api_0004.html @@ -2,7 +2,9 @@-Parent topic: Elastic IP+Parent topic: EIPUpdating an EIP
Function
This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC.
- This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer.
+ Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:- In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
- Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
- Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
URI
PUT /v1/{project_id}/publicips/{publicip_id}
@@ -58,7 +60,7 @@Table 3 Description of the publicip field Name
+Table 3 Description of the publicip field Name
Mandatory
String
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- ERROR (Exceptions)
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- NOTIFYING (Assigning)
- NOTIFY_DELETE (Releasing)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- VPN (Bound to a VPN)
- ERROR (Exceptions)
profile object
Specifies the additional parameters, including the order ID and product ID. For details, see Table 6.
+This parameter is not supported currently.
type
String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP) or 5_mailbgp (Mail BGP).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
String
Specifies the obtained EIP if only IPv4 EIPs are available.
+Specifies the obtained EIP if only IPv4 EIPs are available. (IPv6 is not supported currently.)
ip_version
@@ -160,7 +163,7 @@Integer
Specifies the IP address version. The value can be 4 or 6.
-- 4: IPv4
- 6: IPv6 (IPv6 is not supported currently.)
- 4: IPv4
- 6: IPv6 (IPv6 is not supported currently.)
private_ip_address
@@ -281,19 +284,23 @@ "tenant_id": "26ae5181a416420998eb2093aaed84d9", "create_time": "2019-03-27 01:33:18", "bandwidth_size": 7, - "ip_version": 4 + "ip_version": 4, + "bandwidth_name": "bandwidth-2aef", + "enterprise_project_id": "0", + "bandwidth_share_type": "PER", + "bandwidth_id": "7a258fff-10d8-44b8-8124-c59079eb8f4c" } }-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_api_0005.html b/docs/eip/api-ref/eip_api_0005.html index ccf50eb5..0a2f5c2f 100644 --- a/docs/eip/api-ref/eip_api_0005.html +++ b/docs/eip/api-ref/eip_api_0005.html @@ -2,6 +2,10 @@-Parent topic: Elastic IP+Parent topic: EIPReleasing an EIP
-Function
This API is used to release an EIP.
+ Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:+- In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
- Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
- Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
URI
DELETE /v1/{project_id}/publicips/{publicip_id}
Table 1 describes the parameters. @@ -32,8 +36,8 @@Request Message
- Request parameter -
- Example request
DELETE https://{Endpoint}/v1/{project_id}/publicips+Request Message
-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_apieg_0000.html b/docs/eip/api-ref/eip_apieg_0000.html new file mode 100644 index 00000000..3c8fc805 --- /dev/null +++ b/docs/eip/api-ref/eip_apieg_0000.html @@ -0,0 +1,19 @@ + + + +-Parent topic: Elastic IP+Parent topic: EIPApplication Examples
+ +++ ++ ++ diff --git a/docs/eip/api-ref/eip_apieg_0001.html b/docs/eip/api-ref/eip_apieg_0001.html new file mode 100644 index 00000000..09b2998f --- /dev/null +++ b/docs/eip/api-ref/eip_apieg_0001.html @@ -0,0 +1,113 @@ + + +Assigning an EIP with a Specific Shared Bandwidth
+++Scenarios
This section describes how to assign an EIP with a specific shared bandwidth by calling APIs.
++Prerequisites
If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header when making an API call.
++ The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequent calling.
++Procedure
- Assign a shared bandwidth.
- Send POST https://Endpoint/v2.0/project_id/bandwidths. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Specify the following parameters in the request body:
{ + "bandwidth": { + "name": "bandwidth123", + "size": 10 + } + }+ - Check the response message.
- The request is successful if the following response is displayed. In the response, id indicates the bandwidth ID.
{ + "bandwidth": { + "id": "1bffc5f2-ff19-45a6-96d2-dfdca49cc387", + "name": "bandwidth123", + "size": 10, + "share_type": "WHOLE", + "publicip_info": [], + "tenant_id": "26ae5181a416420998eb2093aaed84d9", + "bandwidth_type": "share", + "charge_mode": "bandwidth", + "enterprise_project_id": "0", + "status": "NORMAL", + "created_at": "2020-04-21T07:58:02Z", + "updated_at": "2020-04-21T07:58:02Z" + } + }+ - For details about the error codes when the request is abnormal, see Error Codes.
- The request is successful if the following response is displayed. In the response, id indicates the bandwidth ID.
- Query the shared bandwidth details.
- Send Get https://Endpoint//v1/project_id/bandwidths/bandwidth_id. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Check the response message.
- The request is successful if the following response is displayed. In the response, id indicates the bandwidth ID.
{ + "bandwidth": { + "id": "1bffc5f2-ff19-45a6-96d2-dfdca49cc387", + "name": "bandwidth123", + "size": 10, + "share_type": "WHOLE", + "publicip_info": [ + { + "publicip_id": "ff156c26-bcc9-4541-a75c-42baf8b9748f", + "publicip_address": "114.xx.xx.244", + "ip_version": 4, + "publicip_type": "5_sbgp" + } + ], + "tenant_id": "b3292dde618e40408e30cd87455a0652", + "bandwidth_type": "sbgp", + "charge_mode": "bandwidth", + "enterprise_project_id": "0", + "status": "NORMAL", + "created_at": "2020-04-21T07:58:02Z", + "updated_at": "2020-04-21T07:58:02Z" + } + }+ - For details about the error codes when the request is abnormal, see Error Codes.
- The request is successful if the following response is displayed. In the response, id indicates the bandwidth ID.
- Assign an EIP using the shared bandwidth.
- Send POST https://Endpoint/v1/project_id/publicips. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Specify the following parameters in the request body:
{ + "publicip": { + "type": "5_bgp", + "ip_version": 6 + }, + "bandwidth": { + "name": "bandwidth123", + "size": 10, + "share_type": "WHOLE", + "id":"1bffc5f2-ff19-45a6-96d2-dfdca49cc387" + }, + "enterprise_project_id":"0" + }+ - Check the response message.
- The request is successful if the following response is displayed.
{ + "publicip": { + "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706", + "status": "PENDING_CREATE", + "type": "5_bgp", + "public_ip_address": "161.xx.xx.7", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "ip_version": 4, + "create_time": "2015-07-16 04:10:52", + "bandwidth_size": 0, + "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439" + } + }+ - For details about the error codes when the request is abnormal, see Error Codes.
- The request is successful if the following response is displayed.
- Query EIP details.
- Send GET /v1/project_id/publicips/publicip_id. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Check the response message.
{ + "publicip": { + "id": "3ec9fea0-2d4c-49e2-8aca-ce883eae547d", + "type": "5_bgp", + "public_ip_address": "10.246.164.87", + "status": "DOWN", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "create_time": "2020-08-13 12:55:27", + "bandwidth_id": "1bffc5f2-ff19-45a6-96d2-dfdca49cc387", + "bandwidth_name": "bandwidth123", + "bandwidth_share_type": "WHOLE", + "bandwidth_size": 10, + "profile": {}, + "enterprise_project_id": "a380829c-db6f-4db3-b5b6-cc377f7a3ff8", + "ip_version": 4 + } + }+
++ diff --git a/docs/eip/api-ref/eip_apieg_0002.html b/docs/eip/api-ref/eip_apieg_0002.html new file mode 100644 index 00000000..d6c22b78 --- /dev/null +++ b/docs/eip/api-ref/eip_apieg_0002.html @@ -0,0 +1,105 @@ + + +++Parent topic: Application Examples+Binding an EIP to an ECS
+++Scenarios
This section describes how to bind an EIP to an ECS by calling APIs.
++Prerequisites
- You have created an ECS. For details, see section "Purchasing an ECS with Customized Configurations" in the Elastic Cloud Server User Guide.
- If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header when making an API call. +
The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequent calling.
+
+Procedure
- Obtain the NIC information based on the ECS ID. For details, see section "Querying a Port" in the Virtual Private Cloud API Reference.
- Send GET https://VPC endpoint/v1/project_id/ports?device_id=ecs_id. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Check the response message.
- The request is successful if the following response is displayed.
{ + "ports": [{ + "id": "02c72193-efec-42fb-853b-c33f2b802467", + "name": "", + "status": "ACTIVE", + "admin_state_up": true, + "fixed_ips": [{ + "subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "ip_address": "192.168.0.75" + }], + "mac_address": "fa:16:3e:47:5f:c1", + "network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", + "project_id": "db82c9e1415a464ea68048baa8acc6b8", + "device_id": "ea61f836-b52f-41bf-9d06-685644001d6f", + "device_owner": "compute:br-iaas-odin1a", + "security_groups": [ + "e0598d96-9451-4f8a-8de0-b8b4d451d9e7" + ], + "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "binding:vif_details": { + "primary_interface": true + }, + "binding:profile": {}, + "port_security_enabled": true, + "created_at": "2020-06-20T08:07:29", + "updated_at": "2020-06-20T08:07:29" + }] + }+ - For details about the error codes when the request is abnormal, see Error Codes.
- The request is successful if the following response is displayed.
- Assign an EIP.
- Send POST https://Endpoint/v1/project_id/publicips. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Specify the following parameters in the request body:
{ + "publicip": { + "type": "5_bgp", + "ip_version": 6 + }, + "bandwidth": { + "name": "bandwidth123", + "size": 5, + "share_type": "WHOLE", + "id":"ebfa375c-3f93-465e-81a3-bd66e578ee9d" + }, + "enterprise_project_id":"0" + }+ - Check the response message.
- The request is successful if the following response is displayed.
{ + "publicip": { + "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706", + "status": "PENDING_CREATE", + "type": "5_bgp", + "public_ip_address": "161.xx.xx.7", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "ip_version": 4, + "create_time": "2015-07-16 04:10:52", + "bandwidth_size": 0, + "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439" + } + }+ - For details about the error codes when the request is abnormal, see Error Codes.
- The request is successful if the following response is displayed.
- Bind the EIP to the ECS NIC.
- Send PUT /v1/project_id/publicips/publicip_id. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Specify the following parameters in the request body:
{ + "publicip": { + "port_id": "02c72193-efec-42fb-853b-c33f2b802467" + } + }+ - Check the response message.
- The request is successful if the following response is displayed.
{ + "publicip": { + "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706", + "status": "ACTIVE", + "type": "5_bgp", + "port_id": "02c72193-efec-42fb-853b-c33f2b802467", + "public_ip_address": "10.xx.xx.162", + "private_ip_address": "192.168.1.131", + "tenant_id": "26ae5181a416420998eb2093aaed84d9", + "create_time": "2019-03-27 01:33:18", + "bandwidth_id": "02da78da-4fb0-4880-b512-f516cdeb8ef3", + "bandwidth_name": "test", + "bandwidth_share_type": "PER", + "bandwidth_size": 1, + "profile": {}, + "enterprise_project_id": "0", + "ip_version": 4 + } + }+ - For details about the error codes when the request is abnormal, see Error Codes.
- The request is successful if the following response is displayed.
++ diff --git a/docs/eip/api-ref/eip_apieg_0003.html b/docs/eip/api-ref/eip_apieg_0003.html new file mode 100644 index 00000000..1aa1340d --- /dev/null +++ b/docs/eip/api-ref/eip_apieg_0003.html @@ -0,0 +1,66 @@ + + +++Parent topic: Application Examples+Unbinding an EIP from an ECS
+++Scenarios
This section describes how to unbind an EIP from an ECS by calling APIs.
++Prerequisites
- You have created an ECS. For details, see section "Purchasing an ECS with Customized Configurations" in the Elastic Cloud Server User Guide.
- If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header when making an API call. +
The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequent calling.
+
+Procedure
- Query EIP details.
- Send GET /v1/project_id/publicips/publicip_id. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Check the response message.
- The request is successful if the following response is displayed.
{ + "publicip": { + "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb", + "status": "ACTIVE", + "type": "5_bgp", + "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe", + "public_ip_address": "10.xx.xx.162", + "private_ip_address": "192.168.1.131", + "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe", + "tenant_id": "26ae5181a416420998eb2093aaed84d9", + "create_time": "2019-03-27 01:33:18", + "bandwidth_id": "02da78da-4fb0-4880-b512-f516cdeb8ef3", + "bandwidth_name": "test", + "bandwidth_share_type": "PER", + "bandwidth_size": 1, + "enterprise_project_id": "0", + "profile": {}, + "ip_version": 4 + } + }+ - For details about the error codes when the request is abnormal, see Error Codes.
- The request is successful if the following response is displayed.
- Unbind the EIP from the ECS NIC.
- Send PUT /v1/project_id/publicips/publicip_id. Parameter project_id indicates the project ID.
- Add X-Auth-Token to the request header.
- Specify the following parameters in the request body:
{ + "publicip": { + "port_id": "" + } + }+
- Check the response message.
- The request is successful if the following response is displayed.
{ + "publicip": { + "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb", + "status": "DOWN", + "type": "5_bgp", + "public_ip_address": "10.xx.xx.162", + "bandwidth_id": "02da78da-4fb0-4880-b512-f516cdeb8ef3", + "bandwidth_name": "test", + "bandwidth_share_type": "PER", + "bandwidth_size": 1, + "tenant_id": "26ae5181a416420998eb2093aaed84d9", + "create_time": "2019-03-27 01:33:18", + "enterprise_project_id": "0", + "profile": {} + "ip_version": 4 + } + }+
- The request is successful if the following response is displayed.
- For details about the error codes when the request is abnormal, see Error Codes.
++ diff --git a/docs/eip/api-ref/eip_apifloatip_0001.html b/docs/eip/api-ref/eip_apifloatip_0001.html index d251795b..f68509bf 100644 --- a/docs/eip/api-ref/eip_apifloatip_0001.html +++ b/docs/eip/api-ref/eip_apifloatip_0001.html @@ -206,7 +206,7 @@ ], "floatingips_links": [ { - "href": "https://network.region.cn-southwest-2.hwclouds.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True", + "href": "https://vpc.region.otctest.t-systems.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True", "rel": "previous" } ] @@ -215,7 +215,7 @@++Parent topic: Application Examples+ - Assign a shared bandwidth.
-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_apifloatip_0002.html b/docs/eip/api-ref/eip_apifloatip_0002.html index 5ac0ad5d..e28114e7 100644 --- a/docs/eip/api-ref/eip_apifloatip_0002.html +++ b/docs/eip/api-ref/eip_apifloatip_0002.html @@ -116,7 +116,7 @@-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_apifloatip_0003.html b/docs/eip/api-ref/eip_apifloatip_0003.html index 6afec093..adcf210e 100644 --- a/docs/eip/api-ref/eip_apifloatip_0003.html +++ b/docs/eip/api-ref/eip_apifloatip_0003.html @@ -228,7 +228,7 @@-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_apifloatip_0004.html b/docs/eip/api-ref/eip_apifloatip_0004.html index 738535e9..62ed48de 100644 --- a/docs/eip/api-ref/eip_apifloatip_0004.html +++ b/docs/eip/api-ref/eip_apifloatip_0004.html @@ -189,7 +189,7 @@-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_apifloatip_0005.html b/docs/eip/api-ref/eip_apifloatip_0005.html index a05a79e4..478982ad 100644 --- a/docs/eip/api-ref/eip_apifloatip_0005.html +++ b/docs/eip/api-ref/eip_apifloatip_0005.html @@ -15,7 +15,7 @@-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_apipermission_0000.html b/docs/eip/api-ref/eip_apipermission_0000.html index 6f67c61f..dacd8992 100644 --- a/docs/eip/api-ref/eip_apipermission_0000.html +++ b/docs/eip/api-ref/eip_apipermission_0000.html @@ -4,7 +4,7 @@-
-
- Elastic IP
+ - EIP
- Bandwidth
diff --git a/docs/eip/api-ref/eip_apipermission_0002.html b/docs/eip/api-ref/eip_apipermission_0002.html
index 922ce034..6b117403 100644
--- a/docs/eip/api-ref/eip_apipermission_0002.html
+++ b/docs/eip/api-ref/eip_apipermission_0002.html
@@ -1,48 +1,48 @@
- - Specifies the resource type.
- Values:
- vpc
- subnet
- securityGroup
- securityGroupRule
- publicIp
- vpn
- vpngw
- vpcPeer
- loadbalancer
- listener
- physicalConnect
- virtualInterface
- firewall
- shareBandwidthIP
- shareBandwidth
- address_group
- flow_log
- vpcContainRoutetable
- routetableContainRoutes
- Specifies the resource type.
- Values:
- vpc: VPC
- subnet: Subnet
- securityGroup: Security group
- securityGroupRule: Security group rule
- publicIp: EIP
- vpn: VPN
- vpcPeer: VPC peering connection
- loadbalancer: Load balancer
- listener: Listener
- physicalConnect: Direct Connect connection
- virtualInterface: Virtual interface
- firewall: Firewall
- shareBandwidthIP: IP address added to a shared bandwidth
- shareBandwidth: Shared bandwidth
- flow_log: VPC fow log
- vpcContainRoutetable: Number of route tables associated with a VPC
- routetableContainRoutes: Number of routes in a route table
Request Message
- Request parameter
None
- - Example request
GET https://{Endpoint}/v1/{project_id}/quotas-
-Request Parameters
None
Response Message
- Response parameter
-
Table 2 Response parameter Name
+Response Parameters
+-Table 2 Response parameter Name
Type
+Type
Description
+Description
quotas
+quotas
quotas object
+quotas object
Specifies the quota object. For details, see Table 3.
+Specifies the quota object. For details, see Table 3.
Table 3 Description of the quotas field Name
+-Table 3 Description of the quotas field Name
Type
+Type
Description
+Description
resources
+resources
Array of resource objects
+Array of resource objects
Specifies the resource objects. For details, see Table 4.
+Specifies the resource objects. For details, see Table 4.
Table 4 Description of the resource field Name
+-Table 4 Description of the resource field Name
Type
+Type
Description
+Description
type
+type
String
+String
- Specifies the resource type.
- Values:
- vpc
- subnet
- securityGroup
- securityGroupRule
- publicIp
- vpn
- vpngw
- vpcPeer
- loadbalancer
- listener
- physicalConnect
- virtualInterface
- firewall
- shareBandwidthIP
- shareBandwidth
- address_group
- flow_log
- vpcContainRoutetable
- routetableContainRoutes
- Specifies the resource type.
- Values:
- vpc: VPC
- subnet: Subnet
- securityGroup: Security group
- securityGroupRule: Security group rule
- publicIp: EIP
- vpn: VPN
- vpcPeer: VPC peering connection
- loadbalancer: Load balancer
- listener: Listener
- physicalConnect: Direct Connect connection
- virtualInterface: Virtual interface
- firewall: Firewall
- shareBandwidthIP: IP address added to a shared bandwidth
- shareBandwidth: Shared bandwidth
- flow_log: VPC fow log
- vpcContainRoutetable: Number of route tables associated with a VPC
- routetableContainRoutes: Number of routes in a route table
used
+used
Integer
+Integer
- Specifies the number of created network resources.
- The value ranges from 0 to the value of quota.
- Specifies the number of created network resources.
- The value ranges from 0 to the value of quota.
quota
+quota
Integer
+Integer
- Specifies the maximum quota values for the resources.
- The value ranges from the default quota value to the maximum quota value.
- The default quota values can be changed. Configure the quota values in the underlying system in advance.
-
- VPC: 150
- Subnet: 400
- Security group: 100
- Security group rule: 5000
- EIPs: 10
- VPNs: 5
- VPC peering connections: 50
- Load balancers: 10
- Listeners: 10
- Firewalls: 200
- EIPs that can be added to a shared bandwidth: 20
- Shared bandwidths: 5
- IP address groups: 50
- Route table per VPC: 1
- Routes per route table: 200
- Specifies the maximum quota values for the resources.
- The value ranges from the default quota value to the maximum quota value.
min
+min
Integer
+Integer
Specifies the minimum quota value allowed.
+Specifies the minimum quota value allowed.
- Example response
{ ++ + If value -1 is returned when you use an API to query your VPC quota, this indicates that the VPC quota is not limited.
+-Example Response
{ "quotas": { "resources": [ { @@ -202,15 +201,27 @@ "used": 0, "quota": 10, "min": 0 + }, + { + "type": "vpcContainRoutetable", + "used": 0, + "quota": 1, + "min": 0 + }, + { + "type": "routetableContainRoutes", + "used": 0, + "quota": 200, + "min": 0 } ] } }-Status Codes
See Status Codes.
+ +-Status Code
See Status Codes.
diff --git a/docs/eip/api-ref/eip_apisharedbandwidth_0001.html b/docs/eip/api-ref/eip_apisharedbandwidth_0001.html index 623d236d..c28202f9 100644 --- a/docs/eip/api-ref/eip_apisharedbandwidth_0001.html +++ b/docs/eip/api-ref/eip_apisharedbandwidth_0001.html @@ -26,13 +26,13 @@
Elastic IP
+EIP
-Permission
+Permission
API
+API
Action
+Action
Assigns an EIP.
+Assigns an EIP.
POST /v1/{project_id}/publicips
+POST /v1/{project_id}/publicips
vpc:publicIps:create
+vpc:publicIps:create
Queries an EIP.
+Queries an EIP.
GET /v1/{project_id}/publicips/{publicip_id}
+GET /v1/{project_id}/publicips/{publicip_id}
vpc:publicIps:get
+vpc:publicIps:get
Queries EIPs.
+Queries EIPs.
GET /v1/{project_id}/publicips
+GET /v1/{project_id}/publicips
vpc:publicIps:list
+vpc:publicIps:list
Updates an EIP.
+Updates an EIP.
PUT /v1/{project_id}/publicips/{publicip_id}
+PUT /v1/{project_id}/publicips/{publicip_id}
vpc:publicIps:update
+vpc:publicIps:update
Release an EIP.
+Release an EIP.
DELETE /v1/{project_id}/publicips/{publicip_id}
+DELETE /v1/{project_id}/publicips/{publicip_id}
vpc:publicIps:delete
+vpc:publicIps:delete
Bandwidth
-Permission
+Permission
API
+API
Action
+Action
Queries a bandwidth.
+Queries a bandwidth.
GET /v1/{project_id}/bandwidths/{bandwidth_id}
+GET /v1/{project_id}/bandwidths/{bandwidth_id}
vpc:bandwidths:get
+vpc:bandwidths:get
Queries bandwidths.
+Queries bandwidths.
GET /v1/{project_id}/bandwidths
+GET /v1/{project_id}/bandwidths
vpc:bandwidths:list
+vpc:bandwidths:list
Updates a bandwidth.
+Updates a bandwidth.
PUT /v1/{project_id}/bandwidths/{bandwidth_id}
+PUT /v1/{project_id}/bandwidths/{bandwidth_id}
vpc:bandwidths:update
+vpc:bandwidths:update
Bandwidth (V2.0)
-Permission
+Permission
API
+API
Action
+Action
Allocates a shared bandwidth.
+Allocates a shared bandwidth.
POST /v2.0/{project_id}/bandwidths
+POST /v2.0/{project_id}/bandwidths
vpc:bandwidths:create
+vpc:bandwidths:create
Deletes a shared bandwidth.
+Deletes a shared bandwidth.
DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}
+DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}
vpc:bandwidths:delete
+vpc:bandwidths:delete
Adds an EIP to a shared bandwidth.
+Adds an EIP to a shared bandwidth.
POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert
+POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert
vpc:publicIps:insert
+vpc:publicIps:insert
Removes an EIP from a shared bandwidth.
+Removes an EIP from a shared bandwidth.
POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove
+POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove
vpc:publicIps:remove
+vpc:publicIps:remove
Querying the Quota
Function
This API is used to query network resource quotas of a tenant. The network resources include VPCs, subnets, security groups, security group rules, EIPs, and VPNs.
- This API is used to query both the EIP and VPC quotas.
+ This API can be used to query quotas of EIPs and VPCs.
URI
GET /v1/{project_id}/quotas
@@ -34,7 +34,7 @@String
Returned Value |
-Description + | Description |
|---|
Module - |
-Status Code - |
-Error Code - |
-Message - |
-Description - |
-Handling Measure - |
-
|---|---|---|---|---|---|
Public - |
-400 - |
-VPC.0002 - |
-Available zone Name is null. - |
-The AZ is left blank. - |
-Check whether the availability_zone field in the request body for creating a subnet is left blank. - |
-
404 - |
-VPC.0003 - |
-VPC does not exist. - |
-The VPC does not exist. - |
-Check whether the VPC ID is correct or whether the VPC exists under the tenant. - |
-|
400 - |
-VPC.0004 - |
-VPC is not active, please try later. - |
-The VPC status is abnormal. - |
-Try again later or contact technical support. - |
-|
401 - |
-VPC.0005 - |
-Lack of user authority. - |
-User restricted. - |
-Check whether the account is in arrears or has not applied for the OBT permission. - |
-|
401 - |
-VPC.0009 - |
-real-name authentication fail. - |
-Real-name authentication fails. - |
-Contact technical support. - |
-|
Public - |
-400 - |
-VPC.0007 - |
-urlTenantId is not equal tokenTenantId - |
-Inconsistent tenant IDs. - |
-The tenant ID in the URL is different from that parsed in the token. - |
-
401 - |
-VPC.0008 - |
-Invalid token in the header. - |
-Invalid token. - |
-Check whether the token in the request header is valid. - |
-|
403 - |
-VPC.2701 - |
-Token not allowed to do this action. - |
-You do not have permission to perform this operation, or your account balance is insufficient. - |
-Check whether the account balance is insufficient or whether your account has been frozen. - |
-|
Public - - |
-403 - |
-VPC.0010 - |
-Rules on xx by ** disallowed by policy - |
-Insufficient permissions to make calls to the underlying system. - |
-Obtain the required permissions. - |
-
403 - |
-VPC.2201 - |
-Policy doesn't allow <x:x:x> to be performed - |
-Insufficient fine-grained permissions. - |
-Obtain the required permissions. - |
-|
Creating a VPC - |
-400 - |
-VPC.0101 - |
-Param is invalid. - |
-VPC parameters are incorrect. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-
409 - |
-VPC.0114 - |
-Quota exceeded for resources: ['router']. - |
-The number of VPCs has reached the maximum allowed limit specified by the quota. - |
-Clear VPC resources that no longer will be used or apply for expanding the VPC resource quota. - |
-|
400 - |
-VPC.0115 - |
-The router name has exist. - |
-The VPC name already exists. - |
-Change the VPC name. - |
-|
Querying a VPC - |
-400 - |
-VPC.0101 - |
-getVpc error vpcId is invalid. - |
-VPC parameters are incorrect. - |
-Ensure that the specified VPC ID is correct. - |
-
404/500 - |
-VPC.0105 - |
-Neutron Error. - |
-Calling the backend service fails. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
500 - |
-VPC.0106 - |
-get router is null. - |
-An error is returned for the failure to call the backend service. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
Querying VPCs - |
-400 - |
-VPC.0101 - |
-Query vpc list error. - |
-Failed to query the VPCs. - |
-Check whether the parameter values are valid based on the returned error message. - |
-
500 - |
-VPC.0105 - |
-Neutron Error. - |
-Calling the backend service fails. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
500 - |
-VPC.0106 - |
-query routers or getList are null. - |
-The response result of calls to the IaaS OpenStack system is null or empty. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
Deleting a VPC - |
-400/404 - |
-VPC.0101 - |
-Delete router error xx is invalid. - |
-Invalid parameters. - |
-Check whether the parameter values are valid based on the returned error message. - |
-
500 - |
-VPC.0102 - |
-Delete router fail. - |
-The interface fails to obtain the routing resources. - |
-Contact technical support. - |
-|
409 - |
-VPC.0103 - |
-Resource status is busy, try it again later. - |
-The VPC cannot be deleted because it is being created. - |
-Contact technical support. - |
-|
409 - |
-VPC.0104 - |
-Router contains subnets, please delete subnet first. - |
-The VPC cannot be deleted because it contains subnets. - |
-Delete the subnet in the VPC. - |
-|
404/500 - |
-VPC.0105 - |
-Neutron Error. - |
-Calling the backend service fails. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
409 - |
-VPC.0107 - |
-Delete the firewall first before deleting the router. - |
-Failed to delete the VPC because it has firewalls associated. - |
-Delete the firewalls of the tenant first. - |
-|
409 - |
-VPC.0108 - |
-Router is used not allow deleted. - |
-Failed to delete the VPC because it has EIPs associated. - |
-Delete the EIPs of the tenant first. - |
-|
409 - |
-VPC.0109 - |
-Router is used not allow deleted. - |
-Failed to delete the VPC because one or more VPNs have been created for it. - |
-Delete VPNs of the tenant. - |
-|
409 - |
-VPC.0110 - |
-deleteDefaultNetworkFromRouter router status is invalid. - |
-The VPC cannot be deleted because its status is unstable. - |
-Contact technical support. - |
-|
500 - |
-VPC.0111 - |
-Database Error. - |
-An internal VPC exception occurs. - |
-Contact technical support. - |
-|
409 - |
-VPC.0112 - |
-Delete the securitygroup first before deleting the router. - |
-The VPC cannot be deleted because it contains security groups. - |
-Delete security groups of the tenant. - |
-|
409 - |
-VPC.0118 - |
-ELB exists under this router, delete ELB firstly. - |
-The VPC cannot be deleted because it contains load balancers. - |
-Delete load balancers in the VPC. - |
-|
500 - |
-VPC.0119 - |
-ELB Error. - |
-An error occurred when the VPC service makes calls to the ELB service. - |
-Check whether the ELB service is normal or contact technical support. - |
-|
409 - |
-VPC.0120 - |
-exroutes exists under this router, delete exroutes firstly. - |
-The VPC cannot be deleted because it contains extension routes. - |
-Delete extension routes in the VPC. - |
-|
Updating a VPC - - |
-400 - |
-VPC.0101 - |
-Update router xx is invalid. - |
-Invalid parameters. - |
-Check whether the parameter values are valid based on the returned error message. - |
-
404/500 - |
-VPC.0105 - |
-Neutron Error. - |
-Calling the backend service fails. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
500 - |
-VPC.0113 - |
-Router status is not active. - |
-The VPC cannot be updated because the status of the VPC is abnormal. - |
-Try again later or contact technical support. - |
-|
400 - |
-VPC.0115 - |
-The router name has exist. - |
-The VPC name already exists. - |
-Change the VPC name. - |
-|
400 - |
-VPC.0117 - |
-Cidr can not contain subnetList cidr. - |
-The subnet parameters are invalid. The VPC CIDR block does not contain all its subnet CIDR blocks. - |
-Change the CIDR block of the VPC. - |
-|
Creating a subnet - |
-400 - |
-VPC.0201 - |
-Subnet name is invalid. - |
-Incorrect subnet parameters. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-
500 - |
-VPC.0202 - |
-Create subnet failed. - |
-An internal error occurs in the subnet. - |
-Contact technical support. - |
-|
400 - |
-VPC.0203 - |
-Subnet is not in the range of VPC. - |
-The CIDR block of the subnet is not in the range of the VPC. - |
-Change the CIDR block of the subnet. - |
-|
400 - |
-VPC.0204 - |
-The subnet has already existed in the VPC, or has been in conflict with the VPC subnet. - |
-The CIDR block of the subnet already exists in the VPC. - |
-Change the CIDR block of the subnet. - |
-|
400 - |
-VPC.0212 - |
-The subnet cidr is not valid. - |
-Invalid subnet CIDR block. - |
-Check whether the subnet CIDR block is valid. - |
-|
Querying a subnet - |
-400 - |
-VPC.0201 - |
-Subnet ID is invalid. - |
-Invalid subnet ID. - |
-Check whether the subnet ID is valid. - |
-
404/500 - |
-VPC.0202 - |
-Query subnet fail. - |
-Failed to query the subnet. - |
-Contact technical support. - |
-|
Querying subnets - |
-400 - |
-VPC.0201 - |
-Query subnets list error. - |
-Failed to query the subnets. - |
-Check whether the parameter values are valid based on the returned error message. - |
-
500 - |
-VPC.0202 - |
-List subnets error. - |
-Failed to query the subnets. - |
-Contact technical support. - |
-|
Deleting a subnet - |
-400 - |
-VPC.0201 - |
-Subnet ID is invalid. - |
-Invalid subnet ID. - |
-Check whether the parameter values are valid based on the returned error message. - |
-
404/500 - |
-VPC.0202 - |
-Neutron Error. - |
-An internal error occurs in the subnet. - |
-Contact technical support. - |
-|
500 - |
-VPC.0206 - |
-Subnet has been used by VPN, please remove the subnet from the VPN and try again. - |
-The subnet cannot be deleted because it is being used by the VPN. - |
-Delete the subnet that is used by the VPN. - |
-|
400 - |
-VPC.0207 - |
-Subnet does not belong to the VPC. - |
-This operation is not allowed because the subnet does not belong to the VPC. - |
-Check whether the subnet is in the VPC. - |
-|
500 - |
-VPC.0208 - |
-Subnet is used by private IP, can not be deleted. - |
-The subnet cannot be deleted because it is being used by the private IP address. - |
-Delete the private IP address of the subnet. - |
-|
500 - |
-VPC.0209 - |
-subnet is still used ,such as computer,LB. - |
-The subnet cannot be deleted because it is being used by an ECS or load balancer. - |
-Delete the ECS or load balancer in the subnet. - |
-|
500 - |
-VPC.0210 - |
-Subnet has been used by routes, please remove the routes first and try again. - |
-The subnet cannot be deleted because it is being used by the custom route. - |
-Delete the custom route. - |
-|
500 - |
-VPC.0211 - |
-subnet is still used by LBaas. - |
-The subnet cannot be deleted because it is being used by load balancers. - |
-Delete load balancers in the subnet. - |
-|
Updating a subnet - |
-400 - |
-VPC.0201 - |
-xx is invalid. - |
-Incorrect subnet parameters. - |
-Check whether the parameter values are valid based on the returned error message. - |
-
404/500 - |
-VPC.0202 - |
-Neutron Error. - |
-An internal error occurs in the subnet. - |
-Contact technical support. - |
-|
500 - |
-VPC.0205 - |
-Subnet states is invalid, please try again later. - |
-The subnet cannot be updated because it is being processed. - |
-Try again later or contact technical support. - |
-|
400 - |
-VPC.0207 - |
-Subnet does not belong to the VPC. - |
-This operation is not allowed because the subnet does not belong to the VPC. - |
-Check whether the subnet is in the VPC. - |
-|
Assigning an EIP - - |
-400 - |
-VPC.0301 - |
-Bandwidth name or share_type is invalid. - |
-The specified bandwidth parameter for assigning an EIP is invalid. - |
-Check whether the specified bandwidth parameter is valid. - |
-
400 - |
-VPC.0501 - |
-Bandwidth share_type is invalid. - |
-Invalid EIP parameters. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-|
403 - |
-VPC.0502 - |
-Tenant status is op_restricted. - |
-You are not allowed to assign the EIP. - |
-Check whether the account balance is insufficient or whether your account has been frozen. - |
-|
500 - |
-VPC.0503 - |
-Creating publicIp failed. - |
-Failed to assign the EIP. - |
-Contact technical support. - |
-|
500 - |
-VPC.0504 - |
-FloatIp is null. - |
-Failed to assign the EIP because no IP address is found. - |
-Contact technical support. - |
-|
500 - |
-VPC.0508 - |
-Port is invalid. - |
-Port-related resources could not be found. - |
-Contact technical support. - |
-|
409 - |
-VPC.0510 - |
-Floatingip has already associated with port. - |
-The EIP has already been bound to another ECS. - |
-Unbind the EIP from the ECS. - |
-|
409 - |
-VPC.0511 - |
-Port has already associated with floatingip. - |
-The port has already been associated with an EIP. - |
-Disassociate the port from the EIP. - |
-|
409 - |
-VPC.0521 - |
-Quota exceeded for resources: ['floatingip']. - |
-Insufficient EIP quota. - |
-Release the unbound EIPs or request to increase the EIP quota. - |
-|
409 - |
-VPC.0522 - |
-The IP address is in use. - |
-The IP address is invalid or in use. - |
-Check whether the IP address format is valid or replace it with another IP address. - |
-|
409 - |
-VPC.0532 - |
-No more IP addresses available on network. - |
-Failed to assign the IP address because no IP addresses are available. - |
-Release unbound EIPs or try again later. - |
-|
Querying an EIP - |
-400 - |
-VPC.0501 - |
-Invalid floatingip_id. - |
-Invalid EIP parameters. - |
-Check whether the EIP ID is valid. - |
-
404 - |
-VPC.0504 - |
-Floating IP could not be found. - |
-The EIP could not be found. - |
-Check whether the specified EIP ID is valid. - |
-|
500 - |
-VPC.0514 - |
-Neutron Error. - |
-An exception occurs in the IaaS OpenStack system. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
Querying EIPs - |
-400 - |
-VPC.0501 - |
-Invalid limit. - |
-Invalid EIP parameters. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-
Releasing an EIP - - - - - - - - |
-400 - |
-VPC.0501 - |
-Invalid param. - |
-Invalid EIP parameters. - |
-Contact technical support. - |
-
404 - |
-VPC.0504 - |
-Floating IP could not be found. - |
-The EIP could not be found. - |
-Check whether the specified EIP ID is valid. - |
-|
409 - |
-VPC.0512 - |
-Resource status is busy, try it again later. - |
-The EIP status is abnormal. - |
-Try again later or contact technical support. - |
-|
500 - |
-VPC.0513 - |
-getElementByKey error. - |
-Network resources cannot be found. - |
-Contact technical support. - |
-|
500 - |
-VPC.0516 - |
-Publicip is in used by ELB. - |
-Failed to release the EIP because it is being used by a load balancer. - |
-Unbind the EIP from the load balancer. - |
-|
409 - |
-VPC.0517 - |
-Floatingip has associated with port, please disassociate it firstly. - |
-Failed to release the EIP because it is bound to an ECS. - |
-Unbind the EIP from the ECS. - |
-|
500 - |
-VPC.0518 - |
-Public IP has firewall rules. - |
-Failed to release the EIP because it is being used by a firewall. - |
-Contact technical support. - |
-|
Updating an EIP - |
-400 - |
-VPC.0501 - |
-Port id is invalid. - |
-Invalid EIP parameters. - |
-Check whether the port ID is valid. - |
-
404 - |
-VPC.0504 - |
-Floating IP could not be found. - |
-The EIP could not be found. - |
-Check whether the specified EIP ID is valid. - |
-|
500 - |
-VPC.0509 - |
-Floating ip double status is invalid. - |
-The port has already been associated with an EIP. - |
-Disassociate the port from the EIP. - |
-|
409 - |
-VPC.0510 - |
-Floatingip has already associated with port. - |
-The EIP has already been bound to another ECS. - |
-Unbind the EIP from the ECS. - |
-|
409 - |
-VPC.0511 - |
-Port has already associated with floatingip. - |
-Failed to bind the EIP to the ECS because another EIP has already been bound to the ECS. - |
-Unbind the EIP from the ECS. - |
-|
409 - |
-VPC.0512 - |
-Resource status is busy, try it again later. - |
-The EIP status is abnormal. - |
-Try again later or contact technical support. - |
-|
404/500 - |
-VPC.0514 - |
-Neutron Error. - |
-An exception occurs in the IaaS OpenStack system. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
Querying a bandwidth - - |
-400 - |
-VPC.0301 - |
-getBandwidth error bandwidthId is invalid. - |
-The bandwidth parameters are incorrect. - |
-Check whether the bandwidth ID is valid. - |
-
404 - |
-VPC.0306 - |
-No Eip bandwidth exist with id. - |
-The bandwidth object does not exist. - |
-The bandwidth object to be queried does not exist. - |
-|
500 - |
-VPC.0302 - |
-Neutron Error. - |
-An exception occurs in the IaaS OpenStack system. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
Querying bandwidths - |
-400 - |
-VPC.0301 - |
-Get bandwidths error limit is invalid. - |
-The bandwidth parameters are incorrect. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-
404 - |
-VPC.0306 - |
-No Eip bandwidth exist with id. - |
-The bandwidth object does not exist. - |
-The bandwidth object to be queried does not exist. - |
-|
500 - |
-VPC.0302 - |
-Neutron Error. - |
-An exception occurs in the IaaS OpenStack system. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
Updating a bandwidth - - |
-400 - |
-VPC.0301 - |
-updateBandwidth input param is invalid. - |
-The bandwidth parameters are incorrect. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-
500 - |
-VPC.0302 - |
-Neutron Error. - |
-Failed to obtain underlying resources. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
500 - |
-VPC.0305 - |
-updateBandwidth error. - |
-An internal error occurs during the bandwidth update. - |
-Contact technical support. - |
-|
Querying quotas - |
-400 - |
-VPC.1207 - |
-resource type is invalid. - |
-The specified resource type does not exist. - |
-Use an existing resource type. - |
-
Assigning a private IP address - - - - |
-500 - |
-VPC.0701 - |
-The IP has been used. - |
-The private IP address already exists. - |
-Change another private IP address and try again. - |
-
400 - |
-VPC.0705 - |
-IP address is not a valid IP for the specified subnet. - |
-Invalid private IP address - |
-Check whether the specified IP address in the request body is within the subnet CIDR block. - |
-|
404 - |
-VPC.2204 - |
-Query resource by id fail. - |
-The resource does not exist or the permission is insufficient. - |
-Check whether the specified subnet in the request body exists or the current account has the permission to query the subnet. - |
-|
409 - |
-VPC.0703 - |
-No more IP addresses available on network xxx. - |
-Insufficient IP addresses. - |
-Check whether the subnet has sufficient IP addresses. - |
-|
Querying a Private IP Address - |
-404 - |
-VPC.0704 - |
-Query resource by id fail. - |
-The private IP address does not exist. - |
-Check whether the private IP address exists. - |
-
Querying Private IP Addresses - |
-400 - |
-VPC.0702 - |
-query privateIps error. - |
-Invalid parameters. - |
-Check whether the parameter values are valid based on the returned error message. - |
-
Releasing a Private IP Address - - - |
-404 - |
-VPC.0704 - |
-Query resource by id fail. - |
-The private IP address does not exist. - |
-Check whether the private IP address exists. - |
-
500 - |
-VPC.0706 - |
-Delete port fail. - |
-An error occurs when the private IP address is being released. - |
-Try again later or contact technical support. - |
-|
409 - |
-VPC.0707 - |
-privateIp is in use. - |
-The private IP address is in use. - |
-Check whether the private IP address is being used by other resource. - |
-|
Creating a security group - - |
-400 - |
-VPC.0601 - |
-Creating securitygroup name is invalid. - |
-The parameters of the security group are incorrect. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-
500 - |
-VPC.0602 - |
-Add security group fail. - |
-An internal error occurs in the security group. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
409 - |
-VPC.0604 - |
-Quota exceeded for resources: ['security_group']. - |
-Insufficient security group quota. - |
-Delete the security group that is no longer required or apply for increasing the quota. - |
-|
Querying a security group - |
-400 - |
-VPC.0601 - |
-Securitygroup id is invalid. - |
-The parameters of the security group are incorrect. - |
-Check whether the security group ID is valid. - |
-
500 - |
-VPC.0602 - |
-Query security group fail. - |
-An internal error occurs in the security group. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
404 - |
-VPC.0603 - |
-Securitygroup is not exist. - |
-The security group does not exist. - |
-Check whether the security group ID is correct or whether the security group exists under the tenant. - |
-|
404/500 - |
-VPC.0612 - |
-Neutron Error. - |
-An internal error occurs in the security group. - |
-Contact technical support. - |
-|
Querying security groups - |
-400 - |
-VPC.0601 - |
-Query security groups error limit is invalid. - |
-The parameters of the security group are incorrect. - |
-Check whether the parameter values are valid based on the returned error message and API reference document. - |
-
500 - |
-VPC.0602 - |
-Query security groups fail. - |
-An internal error occurs in the security group. - |
-Check whether the Neutron service is normal or contact technical support. - |
-|
Associating multiple NIC ports to or disassociating them from a security group at a time - |
-400 - |
-VPC.0606 - |
-Security group id is invalid - |
-Invalid security group ID. - |
-Use a valid security group ID. - |
-
400 - |
-VPC.0606 - |
-Request is invalid - |
-The request structure is missing. - |
-Use a valid request body. - |
-|
400 - |
-VPC.0606 - |
-Request is null - |
-The request is empty. - |
-Use a valid request body. - |
-|
400 - |
-VPC.0606 - |
-Action is invalid - |
-Invalid action value. - |
-Use a valid action value (add or remove). - |
-|
400 - |
-VPC.0606 - |
-Ports list is empty - |
-The ports are an empty list. - |
-Use a valid ports list. - |
-|
400 - |
-VPC.0606 - |
-Port id is invalid - |
-The ports list contains invalid port IDs. - |
-Use a valid ports list. - |
-|
400 - |
-VPC.0609 - |
-Ports list exceeds limit - |
-The ports list contains more than 20 IDs. - |
-Use a valid ports list. - |
-|
400 - |
-VPC.0606 - |
-Endpoint is invalid - |
-Invalid endpoint. - |
-Contact technical support. - |
-|
200 - |
-VPC.0607 - |
-Security group of this instance doesn't exist - |
-The security group does not exist. - |
-Use a valid security group ID. - |
-|
200 - |
-VPC.0607 - |
-An instance must belong to at least one security group - |
-Do not disassociate the instance from the security group when it is associated with only one security group. - |
-Perform other operations. - |
-|
200 - |
-VPC.0608 - |
-Neutron Error - |
-An internal error occurs when you perform batch operations. - |
-Contact technical support. - |
-|
Flow log - - - |
-400 - |
-VPC.3001 - |
-resource could not be found, flowlog id is invalid - |
-Invalid parameters. - |
-Check whether the parameters are valid. - |
-
400 - |
-VPC.3002 - |
-create its topic failed - |
-An error occurred during log topic creation in LTS. - |
-Check whether the parameters are valid. - |
-|
404 - |
-VPC.3002 - |
-NeutronError - |
-Failed to query the flow log. - |
-Check whether the parameters are valid. - |
-|
500 - |
-VPC.3002 - |
-NeutronError - |
-Failed to create the flow log. - |
-Contact technical support. - |
-|
Resource tags - |
-400 - |
-VPC.1801 - |
-resource id is invalid. - |
-Incorrect resource ID. - |
-Use a correct resource ID. - |
-
400 - |
-VPC.1801 - |
-action is invalid. - |
-Invalid action value. - |
-Ensure that the value of action is create or delete. - |
-|
400 - |
-VPC.1801 - |
-Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] - |
-Invalid key length. The key can contain 1 to 36 characters. - |
-Use a valid key value. - |
-|
400 - |
-VPC.1801 - |
-Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] - |
-Invalid value length. -The value can contain 0 to 43 characters. - |
-Use a value of valid length. - |
-|
400 - |
-VPC.1801 - |
-Resource_type xxx is invalid. - |
-Incorrect resource type. - |
-Ensure that the value of resource_type is vpcs. - |
-|
400 - |
-VPC.1801 - |
-Tag can not be null. - |
-The tag list contains value null. - |
-Use valid tags. - |
-|
400 - |
-VPC.1801 - |
-The list of matches contains null. - |
-The matches list contains value null. - |
-Use valid matches. - |
-|
400 - |
-VPC.1801 - |
-Tag value can not be null. - |
-The tags exist, but their values are null. - |
-Use valid tags. - |
-|
400 - |
-VPC.1801 - |
-The value of Matches in resourceInstancesReq is null. - |
-The matches exist, and the value is null. - |
-Use valid matches. - |
-|
400 - |
-VPC.1801 - |
-number of tags exceeds max num of 10. - |
-The tag list contains more than 10 keys. - |
-Use valid tags. - |
-|
400 - |
-VPC.1801 - |
-Tag key is repeated. - |
-The tag list contains duplicate keys. - |
-Use valid tags. - |
-|
400 - |
-VPC.1801 - |
-Value of tags in resourceInstancesReq is duplicate. - |
-There are duplicate tag values in the tag list. - |
-Use valid tags. - |
-|
400 - |
-VPC.1801 - |
-number of tags exceeds max num of 10. - |
-The tag in the tag list has more than 10 tag values. - |
-Use valid tags. - |
-|
400 - |
-VPC.1801 - |
-The key of matches is invalid. - |
-The key in matches is not the resource name. - |
-Use valid matches. - |
-|
400 - |
-VPC.1801 - |
-Limit in resourceInstancesReq is invalid. -Offset in resourceInstancesReq is invalid. - |
-Invalid limit or offset value. - |
-Use valid limit and offset values. - |
-|
400 - |
-VPC.1801 - |
-ResourceInstancesReq is null or invalid. - |
-The tags dictionary structure is missing. - |
-Use a valid tags dictionary structure. - |
-|
400 - |
-VPC.1801 - |
-Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] - |
-The key in tags exceeds the maximum length or is left blank. - |
-Use valid keys in tags. - |
-|
400 - |
-VPC.1801 - |
-Tag length is invalid. The key length must be in range [1,36] and value in range [0,43] - |
-A value in tags exceeds the maximum length. - |
-Use valid values in tags. - |
-|
400 - |
-VPC.1801 - |
-ResourceInstancesReq is null or invalid. - |
-The matches dictionary structure is missing. - |
-Use a valid matches dictionary structure. - |
-|
400 - |
-VPC.1801 - |
-The number of Matches in resourceInstancesReq is 0. - |
-The matches are an empty list. - |
-Use a valid matches list. - |
-|
400 - |
-VPC.1801 - |
-The value's length of Matches in resourceInstancesReq is more than 255. - |
-The matches list contains tag values that contain more than 255 Unicode characters. - |
-Use a valid matches list. - |
-|
500 - |
-VPC.1801 - |
-InvalidInput - |
-Incorrect request body format. - |
-Use the correct request body format. - |
-|
404 - |
-VPC.2204 - |
-Query subnet by id fail. - |
-The resource does not exist or the permission is insufficient. - |
-Use an existing resource or obtain required permission. - |
-|
Querying the network IP address usage - |
-400 - |
-VPC.2301 - |
-parameter network_id is invalid. - |
-The request parameter is incorrect. - |
-Enter a valid network ID. - |
-
400 - |
-VPC.2302 - |
-Network xxx could not be found. - |
-The network is not found. - |
-Ensure that the network ID exists. - |
-
VPC Monitoring Metrics
Description
This section describes monitoring metrics reported by VPC to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the monitoring metrics of the monitored object and alarms generated for VPC.
Namespace
SYS.VPC
+Namespace
SYS.VPC
Metrics
ID @@ -52,7 +52,7 @@ | Outbound Traffic |
-Network traffic going out of the cloud platform + | Network traffic going out of the cloud platform in a minute Unit: byte |
≥ 0 bytes @@ -66,7 +66,7 @@ |
Inbound Traffic |
-Network traffic going into the cloud platform + | Network traffic going into the cloud platform in a minute Unit: byte |
≥ 0 bytes @@ -89,7 +89,7 @@ |
|---|---|---|---|---|---|---|---|---|
publicip_id |
-EIP ID + | EIP ID |
||||||
bandwidth_id diff --git a/docs/eip/api-ref/eip_api07_0000.html b/docs/eip/api-ref/eip_api07_0000.html index 98c30283..08045320 100644 --- a/docs/eip/api-ref/eip_api07_0000.html +++ b/docs/eip/api-ref/eip_api07_0000.html @@ -8,22 +8,100 @@ | ||||||||
2022-06-25 + | ||||||||
2023-07-26 |
-This release incorporates the following changes: -Modified the load balancer types applicable to the 5_gray type in Assigning an EIP, Querying an EIP, Querying EIPs, Updating an EIP, Querying a Bandwidth, Querying Bandwidths, Updating a Bandwidth, Assigning a Shared Bandwidth, and Adding an EIP to a Shared Bandwidth. + | This release incorporates the following changes: +Added descriptions in the function description in Querying All EIPs, Querying EIP Details, Unbinding an EIP, and Binding an EIP. |
||||||
2022-03-03 + | ||||||||
2023-07-03 |
-This release incorporates the following changes: -Added descriptions of parameters private_ip_address and port_id in Querying an EIP, Querying EIPs, and Updating an EIP. + | This release incorporates the following changes: +Modified description about the profile parameter in Querying an EIP, Querying EIPs, and Updating an EIP. + |
+||||||
2023-06-20 + |
+This release incorporates the following change: +Modified request parameters in Querying EIP Tags in a Specified Project. + |
+|||||||
2023-06-06 + |
+This release incorporates the following changes: +Updated the following content: +Changed the value of size in Unbinding an EIP and Binding an EIP. +Changed the value of size in Assigning a Shared Bandwidth and Adding an EIP to a Shared Bandwidth. + |
+|||||||
2023-05-12 + |
+This release incorporates the following changes: +Updated the following content: + |
+|||||||
2023-05-05 + |
+This release incorporates the following changes: +Updated the following content: + |
+|||||||
2023-04-06 + |
+This release incorporates the following changes: +Updated the following content: +Modified the description of the type field in EIPs and Common Pools. + |
+|||||||
2023-02-15 + |
+This release incorporates the following changes: +Updated the following content: + |
+|||||||
2022-12-15 + |
+This release incorporates the following changes: +Modified the following content: + |
+|||||||
2022-12-12 + |
+This release incorporates the following changes: +Modified the following content: +Added description that EIPs of the Dedicated Load Balancer (5_gray) type cannot be created in Assigning an EIP, Releasing an EIP, Querying Floating IP Addresses, Querying a Floating IP Address, Assigning a Floating IP Address, Updating a Floating IP Address, and Deleting a Floating IP Address. + |
+|||||||
2022-11-15 + |
+This release incorporates the following changes: +Added the following content: +Added the APIs for binding and unbinding EIPs in API V3. +Modified the following content: +Added support for binding and unbinding EIPs of the Dedicated Load Balancer (5_gray) type using APIs in Assigning an EIP, Releasing an EIP, Querying Floating IP Addresses, Querying a Floating IP Address, Assigning a Floating IP Address, Updating a Floating IP Address, and Deleting a Floating IP Address. + |
+|||||||
2022-10-30 + |
+This release incorporates the following changes: +Added the following content: + + |
+|||||||
2022-06-25 + |
+This release incorporates the following changes: +Modified the load balancer types applicable to the 5_gray type in Assigning an EIP, Querying a Bandwidth, Querying Bandwidths, Updating a Bandwidth, Assigning a Shared Bandwidth, and Adding an EIP to a Shared Bandwidth. |
|||||||
2022-02-15 |
This release incorporates the following changes: - |
|||||||
2021-12-31 @@ -35,37 +113,37 @@ | ||||||||
2021-08-25 |
This release incorporates the following changes: - |
|||||||
2021-06-18 |
This release incorporates the following changes: - |
|||||||
2021-05-25 |
This release incorporates the following changes: - |
|||||||
2021-05-10 |
This release incorporates the following changes: - |
|||||||
2021-03-16 |
This release incorporates the following changes: -Added description that leaving parameter port_id blank cannot be used to unbind an EIP from a dedicated load balancer in sections Updating an EIP and Updating a Floating IP Address. +Added description that leaving parameter port_id blank cannot be used to unbind an EIP from a dedicated load balancer in Updating a Floating IP Address. |
|||||||
2020-12-16 |
This release incorporates the following changes: - |
|||||||
2020-03-20 diff --git a/docs/eip/api-ref/eip_apiBandwidth_0001.html b/docs/eip/api-ref/eip_apiBandwidth_0001.html index 2804f042..0d330c0f 100644 --- a/docs/eip/api-ref/eip_apiBandwidth_0001.html +++ b/docs/eip/api-ref/eip_apiBandwidth_0001.html @@ -32,7 +32,7 @@ - |
Name +
|
|---|