Function
This API is used to query all EIPs. (This API is not supported in eu-nl.)
+Function
This API is used to query all EIPs.
URI
GET /v3/{project_id}/eip/publicips
@@ -1052,7 +1052,7 @@- FREEZED
- UNFREEZED
bandwith_info
+bandwidth_info
BandwidthInfoResp object
Deleting a Network ACL Rule
+Function
This API is used to delete a network ACL rule that is no longer required.
+URI
PUT /v3/{project_id}/vpc/firewalls/{firewall_id}/remove-rules
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall_id + |
+Yes + |
+String + |
+Definition: +Network ACL ID. You can call the API Querying Network ACLs to obtain the ID of the target network ACL, and then use this API to delete network ACL rules. +Range: +N/A + |
+
project_id + |
+Yes + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall + |
+Yes + |
+FirewallRemoveRuleOption object + |
+Definition: +Request body for removing a network ACL rule. +Constraints: +N/A +Range: +N/A +Default Value: +N/A + |
+
dry_run + |
+No + |
+Boolean + |
+Definition: +Whether to only check the request. +Constraints: +N/A +Range: +
Default Value: +false + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
ingress_rules + |
+No + |
+Array of FirewallRemoveRuleItemOption objects + |
+Definition: +Inbound network ACL rules to be deleted. +Constraints: +Either ingress_rules or egress_rules can be specified. That is, either the inbound or outbound rules can be specified for deleting rules. +Range: +N/A +Default Value: +N/A + |
+
egress_rules + |
+No + |
+Array of FirewallRemoveRuleItemOption objects + |
+Definition: +Outbound network ACL rules to be deleted. +Constraints: +Either ingress_rules or egress_rules can be specified. That is, either the inbound or outbound rules can be specified for deleting rules. +Range: +N/A +Default Value: +N/A + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
firewall + |
+FirewallDetail object + |
+Details after a network ACL rule is deleted. + |
+
request_id + |
+String + |
+Request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL ID. Each network ACL comes with an ID, which uniquely identifies the network ACL. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Name of the network ACL. +Range: +The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
created_at + |
+String + |
+Definition: +Time when the network ACL was created. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
updated_at + |
+String + |
+Definition: +Time when the network ACL was last updated. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
admin_state_up + |
+Boolean + |
+Definition: +Network ACL administrative status. +Range +
|
+
status + |
+String + |
+Definition: +Network ACL status. +Range +
|
+
enterprise_project_id + |
+String + |
+Definition: +ID of the enterprise project that the network ACL belongs to. +Range: +The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. + |
+
tags + |
+Array of ResponseTag objects + |
+Definition: +Tags of a network ACL, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. +Range: +N/A + |
+
associations + |
+Array of FirewallAssociation objects + |
+Definition: +Subnets associated with the network ACL. +Range: +N/A + |
+
ingress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL inbound rules. +Range: +N/A + |
+
egress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL outbound rules. +Range: +N/A + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Definition: +Tag key. +Range: +
|
+
value + |
+String + |
+Definition: +Tag value. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
virsubnet_id + |
+String + |
+Definition: +ID of the subnet associated with the network ACL. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL rule ID. Each network ACL rule comes with an ID, which uniquely identifies the network ACL rule. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Network ACL rule name. +Range: +The value can contain 0 to 255 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL rule. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
action + |
+String + |
+Definition: +Whether a network ACL rule allows or denies traffic. +Range: +
|
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL rule belongs to. +Range: +N/A + |
+
protocol + |
+String + |
+Definition: +Communication protocol of a network ACL rule. +Range: +
|
+
ip_version + |
+Integer + |
+Definition: +IP address version of a network ACL rule. +Range: +
|
+
source_ip_address + |
+String + |
+Definition: +Source IP address or source IP address range of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_ip_address + |
+String + |
+Definition: +Destination IP address or destination IP address range of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
source_port + |
+String + |
+Definition: +Source port of a network ACL rule. +Range: +
|
+
destination_port + |
+String + |
+Definition: +Destination port of a network ACL rule. +Range: +
|
+
source_address_group_id + |
+String + |
+Definition: +ID of the source IP address group of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_address_group_id + |
+String + |
+Definition: +ID of the destination IP address group of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
enabled + |
+Boolean + |
+Definition: +Whether a network ACL rule is enabled. +Range: +
|
+
Example Requests
Delete the inbound rule whose ID is 774cf578-e70d-ec11-a40c-b864b1cf74ea from the network ACL whose ID is e9a7731d-5bd9-4250-a524-b9a076fd5629.
+PUT /v3/{project_id}/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629/remove-rules
+
+{
+ "firewall" : {
+ "ingress_rules" : [ {
+ "id" : "774cf578-e70d-ec11-a40c-b864b1cf74ea"
+ } ]
+ }
+}
+Example Responses
Status code: 200
+Normal response to the PUT operation. For more status codes, see Status Codes.
+{
+ "firewall" : {
+ "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_test1",
+ "description" : "network_acl_test1",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "created_at" : "2022-04-07T07:30:46.000+00:00",
+ "updated_at" : "2022-04-07T07:30:46.000+00:00",
+ "admin_state_up" : true,
+ "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9",
+ "status" : "ACTIVE",
+ "tags" : [ ],
+ "ingress_rules" : [ ],
+ "egress_rules" : [ {
+ "id" : "f9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_rule test",
+ "description" : "network_acl_rule test",
+ "action" : "allow",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "protocol" : "tcp",
+ "ip_version" : 4,
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90"
+ } ],
+ "associations" : [ {
+ "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143"
+ } ]
+ }
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Normal response to the PUT operation. For more status codes, see Status Codes. + |
+
Error Codes
See Error Codes.
+Querying the Details of a Network ACL
+Function
This API is used to query details about a network ACL, including the network ACL name and status.
+URI
GET /v3/{project_id}/vpc/firewalls/{firewall_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall_id + |
+Yes + |
+String + |
+Definition: +Network ACL ID. You can call the API Querying Network ACLs to obtain the ID of the target network ACL, and then use this API to query details about the network ACL. +Range: +N/A + |
+
project_id + |
+Yes + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
Request Parameters
None
+Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
firewall + |
+FirewallDetail object + |
+Definition: +Response body for querying network ACL details. +Range: +N/A + |
+
request_id + |
+String + |
+Definition: +Request ID. +Range: +N/A + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL ID. Each network ACL comes with an ID, which uniquely identifies the network ACL. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Name of the network ACL. +Range: +The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
created_at + |
+String + |
+Definition: +Time when the network ACL was created. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
updated_at + |
+String + |
+Definition: +Time when the network ACL was last updated. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
admin_state_up + |
+Boolean + |
+Definition: +Network ACL administrative status. +Range +
|
+
status + |
+String + |
+Definition: +Network ACL status. +Range +
|
+
enterprise_project_id + |
+String + |
+Definition: +ID of the enterprise project that the network ACL belongs to. +Range: +The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. + |
+
tags + |
+Array of ResponseTag objects + |
+Definition: +Tags of a network ACL, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. +Range: +N/A + |
+
associations + |
+Array of FirewallAssociation objects + |
+Definition: +Subnets associated with the network ACL. +Range: +N/A + |
+
ingress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL inbound rules. +Range: +N/A + |
+
egress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL outbound rules. +Range: +N/A + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Definition: +Tag key. +Range: +
|
+
value + |
+String + |
+Definition: +Tag value. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
virsubnet_id + |
+String + |
+Definition: +ID of the subnet associated with the network ACL. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL rule ID. Each network ACL rule comes with an ID, which uniquely identifies the network ACL rule. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Network ACL rule name. +Range: +The value can contain 0 to 255 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL rule. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
action + |
+String + |
+Definition: +Whether a network ACL rule allows or denies traffic. +Range: +
|
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL rule belongs to. +Range: +N/A + |
+
protocol + |
+String + |
+Definition: +Communication protocol of a network ACL rule. +Range: +
|
+
ip_version + |
+Integer + |
+Definition: +IP address version of a network ACL rule. +Range: +
|
+
source_ip_address + |
+String + |
+Definition: +Source IP address or source IP address range of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_ip_address + |
+String + |
+Definition: +Destination IP address or destination IP address range of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
source_port + |
+String + |
+Definition: +Source port of a network ACL rule. +Range: +
|
+
destination_port + |
+String + |
+Definition: +Destination port of a network ACL rule. +Range: +
|
+
source_address_group_id + |
+String + |
+Definition: +ID of the source IP address group of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_address_group_id + |
+String + |
+Definition: +ID of the destination IP address group of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
enabled + |
+Boolean + |
+Definition: +Whether a network ACL rule is enabled. +Range: +
|
+
Example Requests
Querying the details of a network ACL
+GET https://{Endpoint}/v3/{project_id}/vpc/firewalls/{firewall_id}
+Example Responses
Status code: 200
+Normal response to the GET operation. For more status codes, see Status Codes.
+{
+ "firewall" : {
+ "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_test1",
+ "description" : "network_acl_test1",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "created_at" : "2022-04-07T07:30:46.000+00:00",
+ "updated_at" : "2022-04-07T07:30:46.000+00:00",
+ "admin_state_up" : true,
+ "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9",
+ "status" : "ACTIVE",
+ "tags" : [ ],
+ "ingress_rules" : [ {
+ "id" : "774cf578-e70d-ec11-a40c-b864b1cf74ea",
+ "name" : "network_acl_rule test",
+ "description" : "network_acl_rule test",
+ "action" : "allow",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "protocol" : "tcp",
+ "ip_version" : 4,
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90"
+ } ],
+ "egress_rules" : [ {
+ "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_rule test",
+ "description" : "network_acl_rule test",
+ "action" : "allow",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "protocol" : "tcp",
+ "ip_version" : 4,
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90"
+ } ],
+ "associations" : [ {
+ "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143"
+ } ]
+ }
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Normal response to the GET operation. For more status codes, see Status Codes. + |
+
Error Codes
See Error Codes.
+Querying Tags of a Network ACL
+Function
This API is used to query tags of a specific network ACL.
+URI
GET /v3/{project_id}/firewalls/{firewall_id}/tags
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall_id + |
+Yes + |
+String + |
+The unique ID of a network ACL. +The value is a string in UUID format. +The network ACL with a given ID must exist. + |
+
project_id + |
+Yes + |
+String + |
+Project ID + |
+
Request Parameters
None
+Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Array of ResourceTag objects + |
+Tags + |
+
request_id + |
+String + |
+Request ID + |
+
Example Requests
Query tags of a network ACL.
+GET https://{Endpoint}/v3/{project_id}/firewalls/{firewall_id}/tags
+Example Responses
Status code: 200
+Normal response to the GET operation
+{
+ "request_id" : "95cedc2b-4b3d-4e5c-af29-74576daf5513",
+ "tags" : [ {
+ "key" : "key5",
+ "value" : "value5"
+ }, {
+ "key" : "key1",
+ "value" : "value1"
+ } ]
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Normal response to the GET operation + |
+
Error Codes
See Error Codes.
+Querying EIP Details
-Function
This API is used to query EIP details. (This API is not supported in eu-nl.)
+Function
This API is used to query EIP details. (This API is not supported in eu-nl.)
URI
GET /v3/{project_id}/eip/publicips/{publicip_id}
diff --git a/docs/vpc/api-ref/UpdateFirewall.html b/docs/vpc/api-ref/UpdateFirewall.html new file mode 100644 index 000000000..f165f6605 --- /dev/null +++ b/docs/vpc/api-ref/UpdateFirewall.html @@ -0,0 +1,661 @@ + + +Updating a Network ACL
+Function
This API is used to update the basic information about a network ACL, including the network ACL name and description.
+URI
PUT /v3/{project_id}/vpc/firewalls/{firewall_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall_id + |
+Yes + |
+String + |
+Definition: +Network ACL ID. You can call the API Querying Network ACLs to obtain the ID of the target network ACL, and then use this API to update the network ACL. +Range: +N/A + |
+
project_id + |
+Yes + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall + |
+Yes + |
+UpdateFirewallOption object + |
+Definition: +Request body for updating a network ACL +Constraints: +N/A +Range: +N/A +Default Value: +N/A + |
+
dry_run + |
+No + |
+Boolean + |
+Definition: +Whether to only check the request. +Constraints: +N/A +Range: +
Default Value: +false + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
name + |
+No + |
+String + |
+Definition: +Name of the network ACL. +Constraints: +The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. +Range: +N/A +Default Value: +N/A + |
+
description + |
+No + |
+String + |
+Definition: +Supplementary information about the network ACL. +Constraints: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). +Range: +N/A +Default Value: +N/A + |
+
admin_state_up + |
+No + |
+Boolean + |
+Definition: +Network ACL administrative status. +Constraints: +N/A +Range: +
Default Value: +true + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
firewall + |
+FirewallDetail object + |
+Definition: +Response body for updating a network ACL +Range: +N/A + |
+
request_id + |
+String + |
+Definition: +Request ID. +Range: +N/A + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL ID. Each network ACL comes with an ID, which uniquely identifies the network ACL. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Name of the network ACL. +Range: +The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
created_at + |
+String + |
+Definition: +Time when the network ACL was created. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
updated_at + |
+String + |
+Definition: +Time when the network ACL was last updated. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
admin_state_up + |
+Boolean + |
+Definition: +Network ACL administrative status. +Range +
|
+
status + |
+String + |
+Definition: +Network ACL status. +Range +
|
+
enterprise_project_id + |
+String + |
+Definition: +ID of the enterprise project that the network ACL belongs to. +Range: +The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. + |
+
tags + |
+Array of ResponseTag objects + |
+Definition: +Tags of a network ACL, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. +Range: +N/A + |
+
associations + |
+Array of FirewallAssociation objects + |
+Definition: +Subnets associated with the network ACL. +Range: +N/A + |
+
ingress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL inbound rules. +Range: +N/A + |
+
egress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL outbound rules. +Range: +N/A + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Definition: +Tag key. +Range: +
|
+
value + |
+String + |
+Definition: +Tag value. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
virsubnet_id + |
+String + |
+Definition: +ID of the subnet associated with the network ACL. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL rule ID. Each network ACL rule comes with an ID, which uniquely identifies the network ACL rule. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Network ACL rule name. +Range: +The value can contain 0 to 255 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL rule. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
action + |
+String + |
+Definition: +Whether a network ACL rule allows or denies traffic. +Range: +
|
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL rule belongs to. +Range: +N/A + |
+
protocol + |
+String + |
+Definition: +Communication protocol of a network ACL rule. +Range: +
|
+
ip_version + |
+Integer + |
+Definition: +IP address version of a network ACL rule. +Range: +
|
+
source_ip_address + |
+String + |
+Definition: +Source IP address or source IP address range of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_ip_address + |
+String + |
+Definition: +Destination IP address or destination IP address range of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
source_port + |
+String + |
+Definition: +Source port of a network ACL rule. +Range: +
|
+
destination_port + |
+String + |
+Definition: +Destination port of a network ACL rule. +Range: +
|
+
source_address_group_id + |
+String + |
+Definition: +ID of the source IP address group of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_address_group_id + |
+String + |
+Definition: +ID of the destination IP address group of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
enabled + |
+Boolean + |
+Definition: +Whether a network ACL rule is enabled. +Range: +
|
+
Example Requests
Change the name and description of the network ACL whose ID is e9a7731d-5bd9-4250-a524-b9a076fd5629 to network_acl_test1 and enable the network ACL.
+PUT https://{Endpoint}/v3/9476ea5a8a9849c38358e43c0c3a9e12/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629
+
+{
+ "firewall" : {
+ "name" : "network_acl_test1",
+ "description" : "network_acl_test1",
+ "admin_state_up" : true
+ }
+}
+Example Responses
Status code: 200
+Normal response to the PUT operation. For more status codes, see Status Codes.
+{
+ "firewall" : {
+ "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_test1",
+ "description" : "network_acl_test1",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "created_at" : "2022-04-07T07:30:46.000+00:00",
+ "updated_at" : "2022-04-07T07:30:46.000+00:00",
+ "admin_state_up" : true,
+ "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9",
+ "status" : "ACTIVE",
+ "tags" : [ ],
+ "ingress_rules" : [ {
+ "id" : "774cf578-e70d-ec11-a40c-b864b1cf74ea",
+ "name" : "network_acl_rule test",
+ "description" : "network_acl_rule test",
+ "action" : "allow",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "protocol" : "tcp",
+ "ip_version" : 4,
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90"
+ } ],
+ "egress_rules" : [ {
+ "id" : "f9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_rule test",
+ "description" : "network_acl_rule test",
+ "action" : "allow",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "protocol" : "tcp",
+ "ip_version" : 4,
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90"
+ } ],
+ "associations" : [ {
+ "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143"
+ } ]
+ }
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Normal response to the PUT operation. For more status codes, see Status Codes. + |
+
Error Codes
See Error Codes.
+Updating a Network ACL Rule
+Function
This API is used to update the basic information about a network ACL rule, such as the source address, destination address, source port, and destination port.
+URI
PUT /v3/{project_id}/vpc/firewalls/{firewall_id}/update-rules
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall_id + |
+Yes + |
+String + |
+Definition: +Network ACL ID. You can call the API Querying Network ACLs to obtain the ID of the target network ACL, and then use this API to update network ACL rules. +Range: +N/A + |
+
project_id + |
+Yes + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
firewall + |
+Yes + |
+FirewallUpdateRuleOption object + |
+Definition: +Request body for updating a network ACL rule +Constraints: +N/A +Range: +N/A +Default Value: +N/A + |
+
dry_run + |
+No + |
+Boolean + |
+Definition: +Whether to only check the request. +Constraints: +N/A +Range: +
Default Value: +false + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
ingress_rules + |
+No + |
+Array of FirewallUpdateRuleItemOption objects + |
+Definition: +Inbound network ACL rules to be updated. +Constraints: +
Range: +N/A +Default Value: +N/A + |
+
egress_rules + |
+No + |
+Array of FirewallUpdateRuleItemOption objects + |
+Definition: +Outbound network ACL rules to be updated. +Constraints: +
Range: +N/A +Default Value: +N/A + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
id + |
+Yes + |
+String + |
+Definition: +Network ACL rule ID. +Constraints: +The value is in UUID format with hyphens (-). +Range: +N/A +Default Value: +N/A + |
+
name + |
+No + |
+String + |
+Definition: +Network ACL rule name. +Constraints: +The value can contain 0 to 255 characters, including letters, digits, underscores (_), hyphens (-), and periods. +Range: +N/A +Default Value: +N/A + |
+
description + |
+No + |
+String + |
+Definition: +Supplementary information about the network ACL rule. +Constraints: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). +Range: +N/A +Default Value: +N/A + |
+
action + |
+No + |
+String + |
+Definition: +Whether a network ACL rule allows or denies traffic. +Constraints: +N/A +Range: +
Default Value: +N/A + |
+
protocol + |
+No + |
+String + |
+Definition: +Communication protocol of a network ACL rule. +Constraints: +
Range: +Default Value: +N/A + |
+
ip_version + |
+No + |
+Integer + |
+Definition: +IP address version of a network ACL rule. +Constraints: +N/A +Range: +
Default Value: +N/A + |
+
source_ip_address + |
+No + |
+String + |
+Definition: +Source IP address or source IP address range of a network ACL rule. +Constraints: +source_ip_address and source_address_group_id cannot be specified at the same time. +Range: +N/A +Default Value: +N/A + |
+
destination_ip_address + |
+No + |
+String + |
+Definition: +Destination IP address or destination IP address range of a network ACL rule. +Constraints: +destination_ip_address and destination_address_group_id cannot be specified at the same time. +Range: +N/A +Default Value: +N/A + |
+
source_port + |
+No + |
+String + |
+Definition: +Source port of a network ACL rule. +Constraints: +
Range: +N/A +Default Value: +N/A + |
+
destination_port + |
+No + |
+String + |
+Definition: +Destination port of a network ACL rule. +Constraints: +
Range: +N/A +Default Value: +N/A + |
+
source_address_group_id + |
+No + |
+String + |
+Definition: +ID of the source IP address group of a network ACL rule. +Constraints: +
Range: +N/A +Default Value: +N/A + |
+
destination_address_group_id + |
+No + |
+String + |
+Definition: +ID of the destination IP address group of a network ACL rule. +Constraints: +
Range: +N/A +Default Value: +N/A + |
+
enabled + |
+No + |
+Boolean + |
+Definition: +Whether a network ACL rule is enabled. +Constraints: +N/A +Range: +
Default Value: +true + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
firewall + |
+FirewallDetail object + |
+Definition: +Response body for updating a network ACL rule +Range: +N/A + |
+
request_id + |
+String + |
+Definition: +Request ID. +Range: +N/A + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL ID. Each network ACL comes with an ID, which uniquely identifies the network ACL. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Name of the network ACL. +Range: +The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL belongs to. +Range: +N/A + |
+
created_at + |
+String + |
+Definition: +Time when the network ACL was created. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
updated_at + |
+String + |
+Definition: +Time when the network ACL was last updated. The value is automatically generated by the system. +Range: +The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. + |
+
admin_state_up + |
+Boolean + |
+Definition: +Network ACL administrative status. +Range +
|
+
status + |
+String + |
+Definition: +Network ACL status. +Range +
|
+
enterprise_project_id + |
+String + |
+Definition: +ID of the enterprise project that the network ACL belongs to. +Range: +The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. + |
+
tags + |
+Array of ResponseTag objects + |
+Definition: +Tags of a network ACL, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. +Range: +N/A + |
+
associations + |
+Array of FirewallAssociation objects + |
+Definition: +Subnets associated with the network ACL. +Range: +N/A + |
+
ingress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL inbound rules. +Range: +N/A + |
+
egress_rules + |
+Array of FirewallRuleDetail objects + |
+Definition: +Network ACL outbound rules. +Range: +N/A + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Definition: +Tag key. +Range: +
|
+
value + |
+String + |
+Definition: +Tag value. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
virsubnet_id + |
+String + |
+Definition: +ID of the subnet associated with the network ACL. +Range: +
|
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Definition: +Network ACL rule ID. Each network ACL rule comes with an ID, which uniquely identifies the network ACL rule. +Range: +The value is in UUID format with hyphens (-). + |
+
name + |
+String + |
+Definition: +Network ACL rule name. +Range: +The value can contain 0 to 255 characters, including letters, digits, underscores (_), hyphens (-), and periods. + |
+
description + |
+String + |
+Definition: +Supplementary information about the network ACL rule. +Range: +The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). + |
+
action + |
+String + |
+Definition: +Whether a network ACL rule allows or denies traffic. +Range: +
|
+
project_id + |
+String + |
+Definition: +ID of the project that the network ACL rule belongs to. +Range: +N/A + |
+
protocol + |
+String + |
+Definition: +Communication protocol of a network ACL rule. +Range: +
|
+
ip_version + |
+Integer + |
+Definition: +IP address version of a network ACL rule. +Range: +
|
+
source_ip_address + |
+String + |
+Definition: +Source IP address or source IP address range of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_ip_address + |
+String + |
+Definition: +Destination IP address or destination IP address range of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
source_port + |
+String + |
+Definition: +Source port of a network ACL rule. +Range: +
|
+
destination_port + |
+String + |
+Definition: +Destination port of a network ACL rule. +Range: +
|
+
source_address_group_id + |
+String + |
+Definition: +ID of the source IP address group of a network ACL rule. +Range: +source_ip_address and source_address_group_id cannot be specified at the same time. + |
+
destination_address_group_id + |
+String + |
+Definition: +ID of the destination IP address group of a network ACL rule. +Range: +destination_ip_address and destination_address_group_id cannot be specified at the same time. + |
+
enabled + |
+Boolean + |
+Definition: +Whether a network ACL rule is enabled. +Range: +
|
+
Example Requests
Update the inbound rule whose ID is 774cf578-e70d-ec11-a40c-b864b1cf74ea in the network ACL whose ID is e9a7731d-5bd9-4250-a524-b9a076fd5629.
+PUT https://{Endpoint}/v3/{project_id}/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629/update-rules
+
+{
+ "firewall" : {
+ "ingress_rules" : [ {
+ "id" : "774cf578-e70d-ec11-a40c-b864b1cf74ea",
+ "name" : "network_acl_rule test2",
+ "description" : "network_acl_rule test2",
+ "action" : "allow",
+ "protocol" : "tcp",
+ "ip_version" : "4",
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90",
+ "source_address_group_id" : null,
+ "destination_address_group_id" : null
+ } ]
+ }
+}
+Example Responses
Status code: 200
+Normal response to the PUT operation. For more status codes, see Status Codes.
+{
+ "firewall" : {
+ "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_test1",
+ "description" : "network_acl_test1",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "created_at" : "2022-04-07T07:30:46.000+00:00",
+ "updated_at" : "2022-04-07T07:30:46.000+00:00",
+ "admin_state_up" : true,
+ "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9",
+ "status" : "ACTIVE",
+ "tags" : [ ],
+ "ingress_rules" : [ {
+ "id" : "774cf578-e70d-ec11-a40c-b864b1cf74ea",
+ "name" : "network_acl_rule test2",
+ "description" : "network_acl_rule test2",
+ "action" : "allow",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "protocol" : "tcp",
+ "ip_version" : 4,
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90"
+ } ],
+ "egress_rules" : [ {
+ "id" : "f9a7731d-5bd9-4250-a524-b9a076fd5629",
+ "name" : "network_acl_rule test",
+ "description" : "network_acl_rule test",
+ "action" : "allow",
+ "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
+ "protocol" : "tcp",
+ "ip_version" : 4,
+ "source_ip_address" : "192.168.3.0/24",
+ "destination_ip_address" : "192.168.6.0/24",
+ "source_port" : "30-40,60-90",
+ "destination_port" : "40-60,70-90"
+ } ],
+ "associations" : [ {
+ "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143"
+ } ]
+ }
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Normal response to the PUT operation. For more status codes, see Status Codes. + |
+
Error Codes
See Error Codes.
+Updating an EIP
+Function
This API is used to update an EIP.
+URI
PUT /v3/{project_id}/eip/publicips/{publicip_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Definition: +Project ID. +Range: +N/A. +Maximum: 32 + |
+
publicip_id + |
+Yes + |
+String + |
+EIP ID +Minimum: 36 +Maximum: 36 + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
publicip + |
+Yes + |
+UpdatePublicipOption object + |
+EIP + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
request_id + |
+String + |
+Request ID. + |
+
publicip + |
+PublicipUpdateResp object + |
+Response object of updating an EIP + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
++ | +
project_id + |
+String + |
++ | +
ip_version + |
+Integer + |
++ | +
public_ip_address + |
+String + |
++ | +
public_ipv6_address + |
+String + |
++ | +
status + |
+String + |
+
|
+
description + |
+String + |
++ | +
public_border_group + |
+String + |
++ | +
created_at + |
+String + |
++ | +
updated_at + |
+String + |
++ | +
type + |
+String + |
++ | +
vnic + |
+VnicInfo object + |
++ | +
bandwidth + |
+PublicipBandwidthInfo object + |
+Definition: Bandwidth of an EIP + |
+
enterprise_project_id + |
+String + |
+Definition: Enterprise project ID The value is 0 or a string that contains a maximum of 36 characters in the UUID format with hyphens (-). This is the ID of the enterprise project that you associate with the EIP when you assign the EIP. + |
+
billing_info + |
+String + |
++ | +
lock_status + |
+String + |
++ | +
associate_instance_type + |
+String + |
++ | +
associate_instance_id + |
+String + |
+Definition: ID of the instance with an EIP bound. + |
+
publicip_pool_id + |
+String + |
+Definition: ID of the network that an EIP belongs to. It is the network ID corresponding to publicip_pool_name. + |
+
publicip_pool_name + |
+String + |
++ | +
alias + |
+String + |
++ | +
associate_mode + |
+String + |
++ | +
Example Requests
+Example Responses
Status code: 200
+Normal response to PUT requests
+{
+ "publicip" : {
+ "alias" : "abcd",
+ "associate_instance_id" : null,
+ "associate_instance_type" : null,
+ "bandwidth" : {
+ "billing_info" : "xxxx:xxxx:xxxx",
+ "charge_mode" : "bandwidth",
+ "id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4",
+ "name" : "bandwidth-bd25-test",
+ "share_type" : "WHOLE",
+ "size" : 7
+ },
+ "billing_info" : null,
+ "created_at" : "2020-06-18T14:05:32Z",
+ "description" : "test!!!!",
+ "enterprise_project_id" : "0",
+ "public_border_group" : "center",
+ "id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7",
+ "ip_version" : 4,
+ "lock_status" : null,
+ "project_id" : "060576782980d5762f9ec014dd2f1148",
+ "public_ip_address" : "xx.xx.xx.xx",
+ "public_ipv6_address" : null,
+ "publicip_pool_id" : "160576782980d5762f9ec014dd2f1148",
+ "publicip_pool_name" : "5_mobile",
+ "status" : "DOWN",
+ "type" : "Updating an EIP",
+ "updated_at" : "2020-06-18T14:05:32Z",
+ "vnic" : null
+ },
+ "request_id" : "ead9f912bd1191e3d5f0037141098d91"
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Normal response to PUT requests + |
+
Error Codes
See Error Codes.
+-
+
- Adding EIPs to a Shared Bandwidth in Batches
+ - Querying All EIPs
- Querying EIP Details
+ - Updating an EIP
+ - Unbinding an EIP
- Binding an EIP
diff --git a/docs/vpc/api-ref/eip_tag_0001.html b/docs/vpc/api-ref/eip_tag_0001.html index b14582def..c7b35fa49 100644 --- a/docs/vpc/api-ref/eip_tag_0001.html +++ b/docs/vpc/api-ref/eip_tag_0001.html @@ -32,7 +32,7 @@
Request Message
- Request parameter
+
Request Parameters
- Request parameter
-
Table 2 Request parameter Parameter
Type
@@ -56,7 +56,7 @@Table 3 tag objects Attribute
+ -Request Message
- Request parameter
+-
Request Parameters
Response Message
- Response parameter
+-
Response Parameters
- Response parameter
-
Table 2 Response parameter Parameter
Type
@@ -56,7 +56,7 @@
Request Message
- Request parameter
+
Request Parameters
- Request parameter
-
Table 2 Request parameter Parameter
Type
@@ -70,13 +70,13 @@Table 3 tag objects Attribute
+-Table 3 tag objects Parameter
Type
Mandatory
Description
+Description
Response Message
Request Message
- Request parameter
+
Request Parameters
- Request parameter
Table 2 Request parameter Parameter
Type
@@ -92,7 +92,7 @@Type
Description
+Description
-Table 4 Description of the match field Parameter
+Table 4 Description of the match field Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Response Message
- Response parameter
-
Table 5 Response parameter Parameter
+Response Parameters
- Response parameter
+
Table 5 Response parameter Parameter
Type
+Type
Description
+Description
-Table 6 resource objects Parameter
+Table 6 resource objects Parameter
Type
+Type
Description
+Description
Table 7 Description of the tags field Parameter
+-Table 7 Description of the tags field Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
String
Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.
+Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.
Request Message
- Request parameter
+
-
Response Message
- Response parameter
+
Response Parameters
- Response parameter
Table 2 Response parameter Parameter
Type
@@ -53,7 +53,7 @@Type
Description
+Description
Log in to the network console and view basic information about the firewall. You can view the name and ID of the firewall.
-
+
On the Inbound Rules or Outbound Rules tab, you can add, modify, or delete firewall rules. These rules are associated with the same inbound or outbound policy.
-
+
Example
The following describes how to create firewall resources.
- Creating a firewall rule
POST /v2.0/fwaas/firewall_rules
@@ -104,7 +104,7 @@ }Log in to the network console and view the created firewall resources.
-
+
@@ -113,3 +113,10 @@+ + \ No newline at end of file diff --git a/docs/vpc/api-ref/en-us_topic_0020090596.html b/docs/vpc/api-ref/en-us_topic_0020090596.html index d5725b26a..9f62c3fa0 100644 --- a/docs/vpc/api-ref/en-us_topic_0020090596.html +++ b/docs/vpc/api-ref/en-us_topic_0020090596.html @@ -3,8 +3,8 @@Assigning an EIP
Function
This API is used to assign an EIP.
The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be flexibly bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers.
-
Note the following when you use EIPs of the Dedicated Load Balancer (5_gray) type:@@ -79,7 +79,8 @@- In eu-de, no more new EIPs of this type can be assigned. 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 or unbind BGP EIPs to or from dedicated load balancers.
- 5_gray EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
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 or unbind BGP EIPs to or 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.
String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), or 5_dualStack.
- 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.
- Range:
- For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
- For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
- 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 bandwidth size.
- 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 bandwidth range of each region on the management console.)
- This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
- 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.
- 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 bandwidth range of each region on the management console.)
- This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
- 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.
Response Message
- Response parameter
+
Response Parameters
- Response parameter
-
Table 5 Response parameter Parameter
Type
@@ -230,7 +231,8 @@String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), or 5_dualStack.
- 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.
- Range:
- For region eu-de: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), 5_gray (Dedicated Load Balancer), and 5_dualStack.
- For region eu-nl: 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), and 5_dualStack
- 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.
Table 3 tag objects Attribute
+-Table 3 tag objects Parameter
Type
Table 3 tag objects Attribute
+-Table 3 tag objects Parameter
Type
Yes
Specifies the tag object list. For details, see Table 3.
+Constraints: A maximum of 20 tag key-value pairs are supported.
action
@@ -71,7 +72,7 @@Table 3 tag objects Attribute
+Table 3 tag objects Parameter
Type
Type
Description
+Description
-Table 4 Description of the match field Parameter
+Table 4 Description of the match field Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
String
Specifies the tag key. Currently, the tag key can only be the resource name.
+Minimum length: 1
+Maximum length: 128
value
@@ -205,11 +207,11 @@Response Parameters
-Table 5 Response parameter Parameter
+Table 5 Response parameter Parameter
Type
+Type
Description
+Description
-Table 6 resource objects Parameter
+Table 6 resource objects Parameter
Type
+Type
Description
+Description
Table 7 Description of the tag field Parameter
+Table 7 Description of the tag field Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
String
Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.
+Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.
Type
Description
+Description
Network ACL
++
+++ diff --git a/docs/vpc/api-ref/topic_300000005.html b/docs/vpc/api-ref/topic_300000005.html new file mode 100644 index 000000000..0d945904e --- /dev/null +++ b/docs/vpc/api-ref/topic_300000005.html @@ -0,0 +1,30 @@ + + +-
+
- Creating a Network ACL
+
+ - Querying Network ACLs
+
+ - Querying the Details of a Network ACL
+
+ - Updating a Network ACL
+
+ - Deleting a Network ACL
+
+ - Updating a Network ACL Rule
+
+ - Inserting a Network ACL Rule
+
+ - Deleting a Network ACL Rule
+
+ - Associating a Subnet with a Network ACL
+
+ - Disassociating a Subnet from a Network ACL
+
+
++Parent topic: VPC APIs (V3)+Network ACL Tag Management
++
+++ diff --git a/docs/vpc/api-ref/vpc_api01_0001.html b/docs/vpc/api-ref/vpc_api01_0001.html index e573c8ffa..b79820a3b 100644 --- a/docs/vpc/api-ref/vpc_api01_0001.html +++ b/docs/vpc/api-ref/vpc_api01_0001.html @@ -83,7 +83,8 @@-
+
- Querying the Number of Network ACLs Using Tags
+
+ - Querying Network ACLs Using Tags
+
+ - Adding a Tag to a Network ACL
+
+ - Deleting a Tag from a Network ACL
+
+ - Querying Tags of a Network ACL
+
+ - Adding Tags to a Network ACL in Batches
+
+ - Deleting Tags from a Network ACL in Batches
+
+ - Querying Tags of Network ACLs in a Project
+
+
++Parent topic: VPC APIs (V3)+String
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- If cidr is not specified, the default value is left blank.
- The value must be in CIDR format, for example, 192.168.0.0/16.
String
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- If cidr is not specified, the default value is left blank.
- The value must be in CIDR format, for example, 192.168.0.0/16.
String
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- If cidr is not specified, the default value is left blank.
- The value must be in CIDR format, for example, 192.168.0.0/16.
String
- Specifies the destination network segment of a route.
- Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported.
- Specifies the destination CIDR block of a route.
- Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported.
nexthop
diff --git a/docs/vpc/api-ref/vpc_api01_0003.html b/docs/vpc/api-ref/vpc_api01_0003.html index 554bc428e..a609bcb0b 100644 --- a/docs/vpc/api-ref/vpc_api01_0003.html +++ b/docs/vpc/api-ref/vpc_api01_0003.html @@ -52,7 +52,7 @@Integer
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.
+Specifies the number of records that will be returned on each page. The value is from 0 to 2000. The default value is 2000.
limit can be used together with marker. For details, see the parameter description of marker.
String
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- If cidr is not specified, the value is left blank by default.
- If cidr is specified, the value must be in CIDR format, for example, 192.168.0.0/16.
String
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- If cidr is not specified, the value is left blank by default.
- Constraints:
- The value must be in CIDR format, for example, 192.168.0.0/16.
- If you want to update the CIDR block of the VPC, the new CIDR block must contain all subnets in the VPC.
Array of route objects
- Specifies the route list. For details, see Table 4.
- Specifies the route list. For details, see Table 4.
- Each route table can have a maximum of 200 routes.
String
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- Specifies the available IP address ranges for subnets in the VPC.
- Range:
- If cidr is not specified, the default value is left blank.
- The value must be in CIDR format, for example, 192.168.0.0/16.
VPC.0002
Available zone Name is null.
+AZ name is null.
The AZ is left blank.
VPC.0004
VPC is not active, please try later.
+VPC is not active. Try again later.
The VPC status is abnormal.
VPC.0009
real-name authentication fail.
+Real-name authentication failed.
Real-name authentication fails.
VPC.0007
urlTenantId is not equal tokenTenantId
+Inconsistent tenant IDs.
Inconsistent tenant IDs.
VPC.2701
Token not allowed to do this action.
+Token is not allowed to do this action.
You do not have permission to perform this operation, or your account balance is insufficient.
VPC.0010
Rules on xx by ** disallowed by policy
+Insufficient permissions to call the underlying system.
Insufficient permissions to make calls to the underlying system.
VPC.0101
Param is invalid.
+Invalid VPC parameter values.
VPC parameters are incorrect.
VPC.0115
The router name has exist.
+The router name exists.
The VPC name already exists.
VPC.0105
Neutron Error.
+Neutron error.
Calling the backend service fails.
VPC.0105
Neutron Error.
+Neutron error.
Calling the backend service fails.
VPC.0106
query routers or getList are null.
+The response of router query or getList is null.
The response result of calls to the IaaS OpenStack system is null or empty.
VPC.0102
Delete router fail.
+Router deletion failed.
The interface fails to obtain the routing resources.
VPC.0105
Neutron Error.
+Neutron error.
Calling the backend service fails.
VPC.0108
Router is used not allow deleted.
+Router is being used and cannot be deleted.
Failed to delete the VPC because it has EIPs associated.
VPC.0110
deleteDefaultNetworkFromRouter router status is invalid.
+The VPC cannot be deleted because it is not in the stable status.
The VPC cannot be deleted because its status is unstable.
VPC.0111
Database Error.
+Database error.
An internal VPC exception occurs.
VPC.0112
Delete the securitygroup first before deleting the router.
+Delete the security group first before deleting the router.
The VPC cannot be deleted because it contains security groups.
VPC.0118
ELB exists under this router, delete ELB firstly.
+ELB exists under this router. Delete ELB first.
The VPC cannot be deleted because it contains load balancers.
VPC.0119
ELB Error.
+ELB error.
An error occurred when the VPC service makes calls to the ELB service.
VPC.0120
exroutes exists under this router, delete exroutes firstly.
+Extension routes exist under this router. Delete the routes first.
The VPC cannot be deleted because it contains extension routes.
VPC.0109
Router is used not allow deleted.
+Router is being used and cannot be deleted.
Failed to delete the VPC because one or more VPNs have been created for it.
VPC.0105
Neutron Error.
+Neutron error.
Calling the backend service fails.
VPC.0115
The router name has exist.
+The router name exists.
The VPC name already exists.
VPC.0117
Cidr can not contain subnetList cidr.
+VPC CIDR block cannot contain the subnet CIDR block.
The subnet parameters are invalid. The VPC CIDR block does not contain all its subnet CIDR blocks.
VPC.0204
The subnet has already existed in the VPC, or has been in conflict with the VPC subnet.
+The subnet already exists in the VPC or conflicts with an existing VPC subnet.
The CIDR block of the subnet already exists in the VPC.
VPC.0212
The subnet cidr is not valid.
+Invalid subnet CIDR block.
Invalid subnet CIDR block.
VPC.0202
Neutron Error.
+Neutron error.
An internal error occurs in the subnet.
VPC.0208
Subnet is used by private IP, can not be deleted.
+The subnet cannot be deleted because it has private IP addresses that are being used.
The subnet cannot be deleted because it is being used by the private IP address.
VPC.0209
subnet is still used ,such as computer,LB.
+The subnet is being used by an ECS or a load balancer.
The subnet cannot be deleted because it is being used by an ECS or load balancer.
VPC.0211
subnet is still used by LBaas.
+The subnet is being used by a load balancer.
The subnet cannot be deleted because it is being used by load balancers.
VPC.0202
Neutron Error.
+Neutron error.
An internal error occurs in the subnet.
VPC.0205
Subnet states is invalid, please try again later.
+Invalid subnet status. Try again later.
The subnet cannot be updated because it is being processed.
VPC.0502
Tenant status is op_restricted.
+You are not allowed to assign the EIP.
You are not allowed to assign the EIP.
VPC.0503
Creating publicIp failed.
+Failed to assign the EIP.
Failed to assign the EIP.
VPC.0510
Floatingip has already associated with port.
+EIP has already been bound to a port.
The EIP has already been bound to another ECS.
VPC.0511
Port has already associated with floatingip.
+The port has already been bound with an EIP.
The port has already been associated with an EIP.
VPC.0514
Neutron Error.
+Neutron error.
An exception occurs in the IaaS OpenStack system.
VPC.0513
getElementByKey error.
+Network resources not found.
Network resources cannot be found.
VPC.0516
Publicip is in used by ELB.
+EIP is being used by ELB.
Failed to release the EIP because it is being used by a load balancer.
VPC.0517
Floatingip has associated with port, please disassociate it firstly.
+EIP is bound to a port. Unbind it first.
Failed to release the EIP because it is bound to an ECS.
VPC.0518
Public IP has firewall rules.
+EIP has firewall rules.
Failed to release the EIP because it is being used by a firewall.
VPC.0509
Floating ip double status is invalid.
+The port has already been bound with an EIP.
The port has already been associated with an EIP.
VPC.0510
Floatingip has already associated with port.
+EIP has already been bound to a port.
The EIP has already been bound to another ECS.
VPC.0511
Port has already associated with floatingip.
+The port has already been bound with an EIP.
Failed to bind the EIP to the ECS because another EIP has already been bound to the ECS.
VPC.0514
Neutron Error.
+Neutron error.
An exception occurs in the IaaS OpenStack system.
VPC.0306
No Eip bandwidth exist with id.
+EIP bandwidth with the ID not found.
The bandwidth object does not exist.
VPC.0302
Neutron Error.
+Neutron error.
An exception occurs in the IaaS OpenStack system.
VPC.0306
No Eip bandwidth exist with id.
+EIP bandwidth with the ID not found.
The bandwidth object does not exist.
VPC.0302
Neutron Error.
+Neutron error.
An exception occurs in the IaaS OpenStack system.
VPC.0302
Neutron Error.
+Neutron error.
Failed to obtain underlying resources.
VPC.0305
updateBandwidth error.
+Bandwidth update error.
An internal error occurs during the bandwidth update.
VPC.1207
resource type is invalid.
+Invalid resource type.
The specified resource type does not exist.
VPC.0701
The IP has been used.
+The IP address is in use.
The private IP address already exists.
VPC.0705
IP address is not a valid IP for the specified subnet.
+Invalid IP address for the specified subnet.
Invalid private IP address
VPC.2204
Query resource by id fail.
+Resource query by ID failed.
The resource does not exist or the permission is insufficient.
VPC.0703
No more IP addresses available on network xxx.
+No more IP addresses available on network xxx.
Insufficient IP addresses.
VPC.0704
Query resource by id fail.
+Resource query by ID failed.
The private IP address does not exist.
VPC.0702
query privateIps error.
+Private IP address query error.
Invalid parameters.
VPC.0704
Query resource by id fail.
+Resource query by ID failed.
The private IP address does not exist.
VPC.0706
Delete port fail.
+Deleting port failed.
An error occurs when the private IP address is being released.
VPC.0707
privateIp is in use.
+Private IP address is in use.
The private IP address is in use.
VPC.0601
Creating securitygroup name is invalid.
+Invalid security group name.
The parameters of the security group are incorrect.
VPC.0603
Securitygroup is not exist.
+Security group does not exist.
The security group does not exist.
VPC.0612
Neutron Error.
+Neutron error.
An internal error occurs in the security group.
VPC.1801
InvalidInput
+Invalid input.
Incorrect request body format.
VPC.2301
parameter network_id is invalid.
+Invalid parameter network_id.
The request parameter is incorrect.
VPC.9911
xxx is not a valid cidr format.
+Invalid CIDR block format.
Invalid CIDR block format.
VPC.9912
Input extend cidr num xxx over limit xxx.
+The number of secondary CIDR blocks to be added exceeds the upper limit.
The number of secondary CIDR blocks to be added exceeds the upper limit.
VPC.9914
Add Extend cidr xxx conflict with exist cidr xxx.
+The secondary CIDR block conflicts with an existing CIDR block.
The secondary CIDR block conflicts with an existing CIDR block.
VPC.9916
Add Extend cidr %s conflict with black list cidr %s-24.
+The secondary CIDR block overlaps with a blacklisted CIDR block.
The secondary CIDR block overlaps with a blacklisted CIDR block.
VPC.9915
Extend cidr xxx could not be found.
+The secondary CIDR block to be removed not found.
The secondary CIDR block to be removed does not exist.
The ip_set request body contains duplicate data.
Ensure that the ip_set request body does not contain duplicate data.
+Ensure that the ip_set request body does not contain duplicate data.
400
@@ -2098,7 +2098,7 @@Invalid data in the value of parameter ip_set.
Ensure that the data in the value of parameter ip_set is valid.
+Ensure that the data in the value of parameter ip_set is valid.
409
@@ -2122,7 +2122,7 @@The ip_set request body contains duplicate data.
Ensure that the ip_set request body does not contain duplicate data.
+Ensure that the ip_set request body does not contain duplicate data.
400
@@ -2133,7 +2133,7 @@Invalid data in the value of parameter ip_set.
Ensure that the data in the value of parameter ip_set is valid.
+Ensure that the data in the value of parameter ip_set is valid.
404
@@ -2175,8 +2175,7 @@VPC.9907
1. Addressgroup xxx is used by securitygroup rules.
-2. Addressgroup xxx is used by firewall rules.
+1. The IP address group is used by a security group rule.\n2. The IP address group is used by a network ACL rule.
1. The IP address group is used by a security group rule.
2. The IP address group is used by a network ACL rule.
@@ -2216,7 +2215,7 @@VPC.9904
SecurityGroup xxx could not be found.
+Security group xxx could not be found.
The security group to be updated does not exist.
VPC.9902
Security Group xxx is in use.
+Security group xxx is in use.
The security group to be deleted is associated with a port.
1000 (SI)
Bandwidth or EIP
+bandwidth_id
+publicip_id
1 minute
1000 (SI)
Bandwidth or EIP
+bandwidth_id
+publicip_id
1 minute
1000 (SI)
Bandwidth or EIP
+bandwidth_id
+publicip_id
1 minute
1000 (SI)
Bandwidth or EIP
+bandwidth_id
+publicip_id
1 minute
Change History
-Released On
+Released On
Description
2025-09-09
+2026-04-10
+This release incorporates the following changes:
+Deleted the chapter Port (Discarded).
+2026-03-30
+This release incorporates the following changes:
+Restored the project_id, created_at, and updated_at fields in the response example in Assigning a Floating IP Address and Updating a Floating IP Address.
+2026-03-18
+This release incorporates the following changes:
+- Added the ResourceTagResp table in Querying an EIP and Querying EIPs.
- Deleted 5_gray (Dedicated Load Balancer) of eu-nl from EIP, Bandwidth, and Bandwidth (V2.0).
2026-03-11
+This release incorporates the following changes:
+- Added 5_gray (Dedicated Load Balancer) to the value range of the type parameter in EIP, Bandwidth, and Bandwidth (V2.0).
- Added sections about Floating IP Address (IPv6) APIs.
- Modified the description of the opt_value parameter of the extra_dhcp_opt object in Subnet.
2025-12-12
+This release incorporates the following changes:
+Deleted sections about floating IP address (IPv6) APIs.
+2025-11-11
+This release incorporates the following changes:
+Added sections "Network ACL" and "Network ACL Tag Management".
+2025-10-15
+This release incorporates the following changes:
+Deleted 5_gray (Dedicated Load Balancer) from the value range of the type parameter in Assigning an EIP.
+2025-10-10
+This release incorporates the following changes:
+- Added Updating an EIP and Adding EIPs to a Shared Bandwidth in Batches.
- Added EIP-related content to EIP (V3).
2025-09-09
This release incorporates the following changes:
Modified the parameter description of the name field in Creating a Router and Updating a Router.
@@ -59,13 +107,13 @@2024-09-02
This release incorporates the following changes:
-Deleted parameters created_at and updated_at from section Querying Floating IP Addresses.
+Deleted the created_at and updated_at parameters from section "Querying Floating IP Addresses".
2024-08-25
This release incorporates the following changes:
-Updated the description about parameter updated_at in sections Querying Floating IP Addresses and Querying a Floating IP Address.
+Updated the description of the updated_at parameter in sections "Querying Floating IP Addresses" and "Querying a Floating IP Address".
2024-08-01
@@ -264,7 +312,7 @@2020-03-20
This release incorporates the following changes:
-Added the value of 5_mailbgp for parameters type and publicip_type
+Added the value of 5_mailbgp for parameters type and publicip_type
in sections Assigning an EIP, Bandwidth, and Bandwidth (V2.0).
2018-04-28
This release incorporates the following changes:
-- Opened APIs described in section Floating IP Address (IPv6).
- Added the floating IP address (IPv6) API.
2018-03-30
@@ -368,7 +416,7 @@This release incorporates the following changes:
Updated description in section Updating a Network under Network (Native OpenStack API).
-- Added section Elastic IP Address V2.0 (Extended OpenStack API).
- Deleted the ip_version field from the floatingip object, request parameter, and response parameter in section Floating IP Address (Native OpenStack API).
- Added section Elastic IP Address V2.0 (Extended OpenStack API).
- Deleted the ip_version field from the floatingip object, request parameter, and response parameter in section Floating IP Address (Native OpenStack API).
2017-07-30
diff --git a/docs/vpc/api-ref/vpc_apiroutetab_0001.html b/docs/vpc/api-ref/vpc_apiroutetab_0001.html index 12318e70e..e56faee03 100644 --- a/docs/vpc/api-ref/vpc_apiroutetab_0001.html +++ b/docs/vpc/api-ref/vpc_apiroutetab_0001.html @@ -33,7 +33,7 @@Integer
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.
+Specifies the number of records that will be returned on each page. The value is from 0 to 2000. The default value is 2000.
limit can be used together with marker. For details, see the parameter description of marker.
Table 4 Description of the route field Parameter
Type
+Type
Description
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
-Table 3 Description of the routetable field Parameter
Type
+Type
Description
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
routetable
routetable object
+routetable object
Specifies the route table. For details, see Table 6.
+Specifies the route table. For details, see Table 6.
Table 6 Description of the routetable field Parameter
+-Table 6 Description of the routetable field Parameter
Type
+Type
Description
+Description
id
+id
String
+String
- Specifies the route table ID that uniquely identifies the route table.
- The value must be in standard UUID format.
- Specifies the route table ID, which uniquely identifies the route table.
- The value must be in standard UUID format.
name
+name
String
+String
- Specifies the route table name.
- The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Specifies the route table name.
- The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
default
+default
Boolean
+Boolean
- Specifies whether the route table is the default one.
- The value can be true (default route table) or false (custom route table).
- Specifies whether the route table is the default one.
- The value can be true (default route table) or false (custom route table).
routes
+routes
Array of route objects
+Array of route objects
- Specifies the route list. For details, see Table 4.
- Each route table can have a maximum of 200 routes.
- Specifies the routes. For details, see Table 7.
- Each route table can have a maximum of 200 routes.
subnets
+subnets
Array of subnet objects
+Array of subnet objects
- Specifies the subnets associated with the route table. For details, see Table 5.
- Only subnets in the VPC to which the route table belongs can be associated with the route table.
- Specifies the subnets associated with the route table. For details, see Table 8.
- Only subnets in the VPC that the route table belongs to can be associated with the route table.
tenant_id
+tenant_id
String
+String
- Specifies the project ID.
- Specifies the project ID.
vpc_id
+vpc_id
String
+String
- Specifies the ID of the VPC associated with the route table.
- Specifies the ID of the VPC associated with the route table.
description
+description
String
+String
- Provides supplementary information about the route table.
- The value can contain up to 255 characters and cannot contain angle brackets (< or >).
- Provides supplementary information about the route table.
- The value can contain up to 255 characters and cannot contain angle brackets (< or >).
created_at
+created_at
String
+String
- Specifies the time (UTC) when the route table is created.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the time (UTC) when the resource was created.
- Format: yyyy-MM-ddTHH:mm:ss
updated_at
+updated_at
String
+String
- Specifies the time (UTC) when the route table is updated.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the time (UTC) when the resource was updated.
- Format: yyyy-MM-ddTHH:mm:ss
Table 7 Description of the route field Parameter
+-Table 7 Description of the route field Parameter
Type
+Type
Description
+Description
type
+type
String
+String
- Specifies the route type.
- Values:
- ecs (ECS)
- eni (NIC)
- vip (Virtual IP address)
- nat (NAT gateway)
- peering (VPC peering connection)
- vpn (VPN)
- dc (Direct Connect connection)
- egw: VPC endpoint. This route type is not supported.
- er: enterprise router
- subeni: supplementary network interface. This type of route cannot be created or updated by users.
- local: reserved CIDR block. The destination CIDR block of the route configured cannot overlap with that defined by local.
destination
+destination
String
+String
- Specifies the destination CIDR block of a route.
- Constraints: The value must be in valid IPv4 or IPv6 CIDR formats.
nexthop
+nexthop
String
+String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
description
+description
String
+String
- Provides supplementary information about the route.
- The value can contain up to 255 characters and cannot contain angle brackets (< or >).
Table 8 Description of the subnet field Parameter
+-Table 8 Description of the subnet field Parameter
Type
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
Type
Description
+Description
routetable
routetable object
+routetable object
Specifies the route table. For details, see Table 9.
+Specifies the route table. For details, see Table 9.
Table 9 Description of the routetable field Parameter
+-Table 9 Description of the routetable field Parameter
Type
+Type
Description
+Description
id
+id
String
+String
- Specifies the route table ID that uniquely identifies the route table.
- The value must be in standard UUID format.
- Specifies the route table ID, which uniquely identifies the route table.
- The value must be in standard UUID format.
name
+name
String
+String
- Specifies the route table name.
- The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Specifies the route table name.
- The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
default
+default
Boolean
+Boolean
- Specifies whether the route table is the default one.
- The value can be true (default route table) or false (custom route table).
- Specifies whether the route table is the default one.
- The value can be true (default route table) or false (custom route table).
routes
+routes
Array of route objects
+Array of route objects
- Specifies the route list. For details, see Table 4.
- Each route table can have a maximum of 200 routes.
- Specifies the routes. For details, see Table 10.
- Each route table can have a maximum of 200 routes.
subnets
+subnets
Array of subnet objects
+Array of subnet objects
- Specifies the subnets associated with the route table. For details, see Table 5.
- Only subnets in the VPC to which the route table belongs can be associated with the route table.
- Specifies the subnets associated with the route table. For details, see Table 11.
- Only subnets in the VPC that the route table belongs to can be associated with the route table.
tenant_id
+tenant_id
String
+String
- Specifies the project ID.
- Specifies the project ID.
vpc_id
+vpc_id
String
+String
- Specifies the ID of the VPC associated with the route table.
- Specifies the ID of the VPC associated with the route table.
description
+description
String
+String
- Provides supplementary information about the route table.
- The value can contain up to 255 characters and cannot contain angle brackets (< or >).
- Provides supplementary information about the route table.
- The value can contain up to 255 characters and cannot contain angle brackets (< or >).
created_at
+created_at
String
+String
- Specifies the time (UTC) when the route table is created.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the time (UTC) when the resource was created.
- Format: yyyy-MM-ddTHH:mm:ss
updated_at
+updated_at
String
+String
- Specifies the time (UTC) when the route table is updated.
- Format: yyyy-MM-ddTHH:mm:ss
- Specifies the time (UTC) when the resource was updated.
- Format: yyyy-MM-ddTHH:mm:ss
Table 10 Description of the route field Parameter
+-Table 10 Description of the route field Parameter
Type
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
Table 11 Description of the subnet field Parameter
+@@ -246,7 +262,7 @@Table 11 Description of the subnet field Parameter
Type
Array of strings
Specifies a list of IDs of the subnets to be associated with the route table.
+By default, a route table can be associated with a maximum of 100 subnets.
disassociate
@@ -112,6 +113,7 @@Array of strings
Specifies a list of IDs of the subnets to be disassociated from the route table.
+By default, a route table can be disassociated from a maximum of 100 subnets.
- Provides supplementary information about the route table.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
created_at
+String
+- Specifies the time (UTC) when the route table is created.
- Format: yyyy-MM-ddTHH:mm:ss
updated_at
+String
+- Specifies the time (UTC) when the route table is updated.
- Format: yyyy-MM-ddTHH:mm:ss
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
Array of strings
Specifies the IDs of the subnets to be associated with the route table.
+By default, a route table can be associated with a maximum of 100 subnets.
disassociate
@@ -111,6 +112,7 @@Array of strings
Specifies the IDs of the subnets to be disassociated from the route table.
+By default, a route table can be disassociated from a maximum of 100 subnets.
String
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- Specifies the ID of the next hop in the route.
- Values:
- When type is ecs, the value is an ECS ID.
- When type is eni, the value is an extension NIC ID.
- When type is vip, the value is a virtual IP address.
- When type is nat, the value is a NAT gateway ID.
- When type is peering, the value is a VPC peering connection ID.
- When type is vpn, the value is a VPN ID.
- When type is dc, the value is a Direct Connect connection ID.
- When type is set to egw, the value is a VPC endpoint ID.
- When type is set to er, the value is the ID of an enterprise router.
- When type is set to subeni, the value is the ID of a supplementary network interface.
- IP Address Group
+ - Network ACL
+
+ - Network ACL Tag Management
+ - EIPs
- Common Pools
diff --git a/docs/vpc/api-ref/vpc_apiv3_0003.html b/docs/vpc/api-ref/vpc_apiv3_0003.html index bc7b13d51..5611d49da 100644 --- a/docs/vpc/api-ref/vpc_apiv3_0003.html +++ b/docs/vpc/api-ref/vpc_apiv3_0003.html @@ -1,30 +1,30 @@Querying VPCs
-Function
After a VPC is created, you can call this API to query all information about the VPC, including the VPC name, ID, and CIDR block.
+-Function
After a VPC is created, you can call this API to query all information about the VPC, including the VPC name, ID, and CIDR block.
Constraints
This API is used to query all VPCs accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. If the number of records exceeds 2000, the pagination marker will be returned.
+-Constraints
This API is used to query all VPCs accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. If the number of records exceeds 2000, the pagination marker will be returned.
URI
GET /v3/{project_id}/vpc/vpcs
+URI
GET /v3/{project_id}/vpc/vpcs
-Table 1 Path Parameters Parameter
+-Table 1 Path Parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Table 2 Query Parameters Parameter
+-Table 2 Query Parameters Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
limit
+limit
No
+No
Integer
+Integer
marker
+marker
No
+No
String
+String
Definition: ID of the resource from which the pagination query starts. If the parameter is left blank, only resources on the first page are queried.
--
+
Definition: ID of the resource from which the pagination query starts. If the parameter is left blank, only resources on the first page are queried.
+Range: VPC ID.
id
+id
No
+No
Array of strings
+Array of strings
name
+name
No
+No
Array of strings
+Array of strings
description
+description
No
+No
Array of strings
+Array of strings
cidr
+cidr
No
+No
Array of strings
+Array of strings
Request Parameters
None
+-Request Parameters
None
Response Parameters
Status code: 200
+Response Parameters
Status code: 200
-Table 3 Response body parameters Parameter
+-Table 3 Response body parameters Parameter
Type
+Type
Description
+Description
request_id
+request_id
String
+String
vpcs
+vpcs
Array of Vpc objects
+Array of Vpc objects
page_info
+page_info
PageInfo object
+PageInfo object
Table 4 Vpc Parameter
+-Table 4 Vpc Parameter
Type
+Type
Description
+Description
id
+id
String
+String
Definition: VPC ID. After a VPC is created, a VPC ID is generated, which uniquely identifies the VPC.
-Range: The value is in UUID format with hyphens (-).
+Definition: VPC ID. After a VPC is created, a VPC ID is generated, which uniquely identifies the VPC.
+Range: The value is in UUID format with hyphens (-).
name
+name
String
+String
description
+description
String
+String
cidr
+cidr
String
+String
- -
-
-
10.0.0.0/8–24: The IP address ranges from 10.0.0.0 to 10.255.255.255, and the netmask ranges from 8 to 24.
-172.16.0.0/12–24: The IP address ranges from 172.16.0.0 to 172.31.255.255, and the netmask ranges from 12 to 24.
-192.168.0.0/16–24: The IP address ranges from 192.168.0.0 to 192.168.255.255, and the netmask ranges from 16 to 24.
-If cidr is not specified, the default value is "".
+Definition: Available subnets in a VPC.
+Range:
+10.0.0.0/8–24: The IP address ranges from 10.0.0.0 to 10.255.255.255, and the netmask ranges from 8 to 24.
+172.16.0.0/12–24: The IP address ranges from 172.16.0.0 to 172.31.255.255, and the netmask ranges from 12 to 24.
+192.168.0.0/16–24: The IP address ranges from 192.168.0.0 to 192.168.255.255, and the netmask ranges from 16 to 24.
+If cidr is not specified, the default value is "".
extend_cidrs
+extend_cidrs
Array of strings
+Array of strings
- -
Range: The following CIDR blocks are not supported:
-10.0.0.0/8: The IP address range is 10.0.0.0-10.255.255.255.
-172.16.0.0/12: The IP address range is 172.16.0.0-172.31.255.255.
-192.168.0.0/16: The IP address range is 192.168.0.0-192.168.255.255.
-172.31.0.0/16: The IP address range is 172.31.0.0-172.31.255.255.
-100.64.0.0/10: The IP address range is 100.64.0.0-100.127.255.255.
-214.0.0.0/7: The IP address range is 214.0.0.0-215.255.255.255.
-198.18.0.0/15: The IP address range is 198.18.0.0-198.19.255.255.
-169.254.0.0/16: The IP address range is 169.254.0.0-169.254.255.255.
-- -
127.0.0.0/8: The IP address range is 127.0.0.0-127.255.255.255.
-240.0.0.0/4: The IP address range is 240.0.0.0-255.255.255.255.
+Definition: Secondary CIDR blocks of a VPC.
+Range: The following CIDR blocks are not supported:
+10.0.0.0/8: The IP address range is 10.0.0.0-10.255.255.255.
+172.16.0.0/12: The IP address range is 172.16.0.0-172.31.255.255.
+192.168.0.0/16: The IP address range is 192.168.0.0-192.168.255.255.
+172.31.0.0/16: The IP address range is 172.31.0.0-172.31.255.255.
+100.64.0.0/10: The IP address range is 100.64.0.0-100.127.255.255.
+214.0.0.0/7: The IP address range is 214.0.0.0-215.255.255.255.
+198.18.0.0/15: The IP address range is 198.18.0.0-198.19.255.255.
+169.254.0.0/16: The IP address range is 169.254.0.0-169.254.255.255.
+0.0.0.0/8: The IP address range is 0.0.0.0-0.255.255.255.
+127.0.0.0/8: The IP address range is 127.0.0.0-127.255.255.255.
+240.0.0.0/4: The IP address range is 240.0.0.0-255.255.255.255.
status
+status
String
+String
project_id
+project_id
String
+String
enterprise_project_id
+enterprise_project_id
String
+String
Definition: ID of the enterprise project that a VPC belongs to.
-Range: The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.
+Definition: ID of the enterprise project that a VPC belongs to.
+Range: The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.
created_at
+created_at
String
+String
updated_at
+updated_at
String
+String
cloud_resources
+cloud_resources
Array of CloudResource objects
+Array of CloudResource objects
tags
+tags
Array of ResponseTag objects
+Array of ResponseTag objects
Definition: Tags of a VPC, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.
--
+
Definition: Tags of a VPC, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.
+Range: None
Table 5 CloudResource Parameter
+-Table 5 CloudResource Parameter
Type
+Type
Description
+Description
resource_type
+resource_type
String
+String
resource_count
+resource_count
Integer
+Integer
Table 6 ResponseTag Parameter
+-Table 6 ResponseTag Parameter
Type
+Type
Description
+Description
key
+key
String
+String
- -
-
-
Each key can contain up to 36 Unicode characters and cannot be left blank.
-- -
-
-
+
Definition:
+Tag key.
+Range:
+A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.
+Each tag key of a resource must be unique.
+The value can contain:
+Letters
+Digits
+Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), at signs (@), and equal signs (=)
value
+value
String
+String
- -
-
-
Each value can contain up to 43 Unicode characters and can be left blank.
--
-
+
Definition:
+Tag value.
+Range:
+Each value can contain a maximum of 255 Unicode characters and can be left blank.
+The value can contain:
+Letters
+Digits
+Special characters: underscores (_), colons (:), plus signs (+), hyphens (-), at signs (@), and equal signs (=)
Table 7 PageInfo Parameter
+-Table 7 PageInfo Parameter
Type
+Type
Description
+Description
previous_marker
+previous_marker
String
+String
+ Definition:
+The first record on the current page.
+Range:
+N/A
current_count
+current_count
Integer
+Integer
+ Definition:
+Total number of resources on the current page.
+Range:
+N/A
next_marker
+next_marker
String
+String
+ Definition:
+The last record on the current page. The next_marker field does not exist if the page is the last one.
+Range:
+N/A
Example Requests
-
-
GET https://{Endpoint}/v3/{project_id}/vpc/vpcs- -
-
GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?id=01ab4be1-4447-45fb-94be-3ee787ed4ebe&id=02cd5ef2-4447-36fb-75be-3ee787ed6adf- -
-
GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?name=vpc-test- -
-
GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe+-Example Requests
Querying VPCs
+GET https://{Endpoint}/v3/{project_id}/vpc/vpcs+Querying VPCs by VPC ID
+GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?id=01ab4be1-4447-45fb-94be-3ee787ed4ebe&id=02cd5ef2-4447-36fb-75be-3ee787ed6adf+Querying VPCs by VPC name
+GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?name=vpc-test+Querying VPCs by page
+GET https://{Endpoint}/v3/{project_id}/vpc/vpcs?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe
Example Responses
Status code: 200
-Normal response to the GET operation. For more status codes, see Status Code.
-{ +-Example Responses
Status code: 200
+Normal response to the GET operation. For more status codes, see Status Code.
+{ "request_id" : "9c1838ba498249547be43dd618b58d27", "vpcs" : [ { "id" : "01da5a65-0bb9-4638-8ab7-74c64e24a9a7", @@ -487,23 +490,23 @@ } }Status Codes
-Status Code
+-Status Codes
+Status Code
Description
+Description
200
+200
Normal response to the GET operation. For more status codes, see Status Code.
+Normal response to the GET operation. For more status codes, see Status Code.
diff --git a/docs/vpc/api-ref/vpc_apiv3_0004.html b/docs/vpc/api-ref/vpc_apiv3_0004.html index 23553ab4f..36ce27463 100644 --- a/docs/vpc/api-ref/vpc_apiv3_0004.html +++ b/docs/vpc/api-ref/vpc_apiv3_0004.html @@ -1,39 +1,39 @@Querying the Details of a VPC
-Function
After a VPC is created, you can call this API to query all information about the VPC, including the VPC name, ID, and CIDR block.
+-Function
After a VPC is created, you can call this API to query all information about the VPC, including the VPC name, ID, and CIDR block.
URI
GET /v3/{project_id}/vpc/vpcs/{vpc_id}
+URI
GET /v3/{project_id}/vpc/vpcs/{vpc_id}
-
- Response parameter
- Response parameter
- Response parameter
+
- Request parameter
+
-
- Response parameter
+
- Response parameter
-
- Request parameter
- Request parameter
+
- Request parameter
- Response parameter
- Response parameter
+
- Request parameter
+
- Request parameter