-
diff --git a/docs/vpc/api-ref/eip_tag_0001.html b/docs/vpc/api-ref/eip_tag_0001.html
index 42214ee8..6575eff7 100644
--- a/docs/vpc/api-ref/eip_tag_0001.html
+++ b/docs/vpc/api-ref/eip_tag_0001.html
@@ -1,7 +1,7 @@
-
- Request parameter
+diff --git a/docs/vpc/api-ref/eip_tag_0003.html b/docs/vpc/api-ref/eip_tag_0003.html index ff227cd4..18513fb9 100644 --- a/docs/vpc/api-ref/eip_tag_0003.html +++ b/docs/vpc/api-ref/eip_tag_0003.html @@ -1,45 +1,45 @@ -
Request Message
Deleting an EIP Tag
-Function
This API is used to delete an EIP tag.
+Deleting an EIP Tag
+Function
This API is used to delete an EIP tag.
URI
DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
-Table 1 describes the parameters.
+Table 1 describes the parameters.
-Table 1 Parameter description Name
+-Table 1 Parameter description Name
Mandatory
+Mandatory
Description
+Description
project_id
+project_id
Yes
+Yes
Specifies the project ID.
+Specifies the project ID.
publicip_id
+publicip_id
Yes
+Yes
Specifies the unique identifier of an EIP.
+Specifies the unique identifier of an EIP.
key
+key
Yes
+Yes
Specifies the tag key.
+Specifies the tag key.
Request Message
- Request parameter
+diff --git a/docs/vpc/api-ref/eip_tag_0004.html b/docs/vpc/api-ref/eip_tag_0004.html index 80df1485..7c35c959 100644 --- a/docs/vpc/api-ref/eip_tag_0004.html +++ b/docs/vpc/api-ref/eip_tag_0004.html @@ -1,7 +1,7 @@ -
Request Message
Batch Creating or Deleting EIP Tags
-Function
This API is used to add multiple tags to or delete multiple tags from an EIP at a time.
+Batch Creating or Deleting EIP Tags
+Function
This API is used to add multiple tags to or delete multiple tags from an EIP at a time.
This API is idempotent.
If there are duplicate keys in the request body when you add tags, an error is reported.
During tag creation, duplicate keys are not allowed. If a key already exists in the database, its value will be overwritten by the new duplicate key.
@@ -76,7 +76,7 @@
Mandatory
Description
+Description
Querying EIPs by Tag
+Querying EIPs by Tag
Function
This API is used to query EIPs by tag.
URI
POST /v2.0/{project_id}/publicips/resource_instances/action
@@ -92,7 +92,7 @@Type
Description
+Description
-Table 4 Description of the match field Name
+Table 4 Description of the match field Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
Response Message
- Response parameter
-
Table 5 Response parameter Name
+Table 5 Response parameter Name
Type
+Type
Description
+Description
-Table 6 resource objects Name
+Table 6 resource objects Name
Type
+Type
Description
+Description
-Table 3 Description of the tag field Name
+Table 3 Description of the tag field Name
Type
Description
+Description
String
Specifies the tag key.
-- Cannot be left blank.
- Can contain a maximum of 36 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- Cannot be left blank.
- Contain up to 128 characters (36 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
Array of strings
Specifies the tag value list.
-- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- Contain up to 255 characters (43 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
Route Table
-Permission
+Permission
API
+API
Action
+Action
Querying Route Tables
+Querying Route Tables
GET /v1/{project_id}/routetables
+GET /v1/{project_id}/routetables
vpc:routeTables:list
+vpc:routeTables:list
Querying a Route Table
+Querying a Route Table
GET /v1/{project_id}/routetables/{routetable_id}
+GET /v1/{project_id}/routetables/{routetable_id}
vpc:routeTables:get
+vpc:routeTables:get
Creating a Route Table
+Creating a Route Table
POST /v1/{project_id}/routetables
+POST /v1/{project_id}/routetables
vpc:routeTables:create
+vpc:routeTables:create
Updating a Route Table
+Updating a Route Table
UPDATE /v1/{project_id}/routetables/{routetable_id}
+PUT /v1/{project_id}/routetables/{routetable_id}
vpc:routeTables:update
+vpc:routeTables:update
Associating Subnets with a Route Table
+Associating Subnets with a Route Table
POST /v1/{project_id}/routetables/{routetable_id}/action
+POST /v1/{project_id}/routetables/{routetable_id}/action
vpc:routeTables:associate
+vpc:routeTables:associate
Disassociating Subnets from a Route Table
+Disassociating Subnets from a Route Table
POST /v1/{project_id}/routetables/{routetable_id}/action
+POST /v1/{project_id}/routetables/{routetable_id}/action
vpc:routeTables:associate
+vpc:routeTables:associate
Deleting a Route Table
+Deleting a Route Table
DELETE /v1/{project_id}/routetables/{routetable_id}
+DELETE /v1/{project_id}/routetables/{routetable_id}
vpc:routeTables:delete
+vpc:routeTables:delete
What Are the Relationships Among Firewall Groups, Policies, and Rules?
+++ +Relationships
Firewall resources are classified into groups, policies, and rules.
+The relationships among them are as follows:
+- A firewall policy can be associated with multiple firewall rules.
- A firewall group can be associated with two firewall policies. One policy controls inbound traffic and the other controls outbound traffic.
- A firewall policy must be associated with a firewall group.
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
+Request body
+{ + "firewall_rule": { + "name": "fw-rule-ingress-1", + "description": "create a ingress firewall rule ", + "protocol": "TCP", + "action": "ALLOW", + "ip_version": 4, + "destination_ip_address": "192.168.22.0/24", + "source_ip_address": "0.0.0.0/0", + "enabled": true + } +}+Response body of obtaining firewall_rule_id: 84d10f4a-9f8b-41b8-bdfa-5a0f18736f12
+{ + "firewall_rule": { + "protocol": "tcp", + "description": "create a ingress firewall rule ", + "source_ip_address": "0.0.0.0/0", + "destination_ip_address": "192.168.22.0/24", + "source_port": null, + "destination_port": null, + "id": "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12", + "name": "fw-rule-ingress-1", + "tenant_id": "5f6387106c2048b589b369d96c2f23a2", + "project_id": "5f6387106c2048b589b369d96c2f23a2", + "enabled": true, + "action": "allow", + "ip_version": 4, + "public": false + } +}+- Creating a firewall policy
POST /v2.0/fwaas/firewall_policies
+Request body of associating with a firewall rule
+{ + "firewall_policy": { + "description": "create a ingress firewall policy", + "firewall_rules": [ + "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12" + ], + "name": "fw-policy-ingress" + } +}+Response body of obtaining firewall_policy_id: da037721-b895-4e07-bbcc-f5f6ac2759fb
+{ + "firewall_policy": { + "id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", + "name": "fw-policy-ingress", + "project_id": "5f6387106c2048b589b369d96c2f23a2", + "tenant_id": "5f6387106c2048b589b369d96c2f23a2", + "description": "create a ingress firewall policy", + "firewall_rules": [ + "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12" + ], + "audited": false, + "public": false + } +}+- Creating a firewall group
POST /v2.0/fwaas/firewall_groups
+Request body of associating with an inbound firewall policy
+{ + "firewall_group": { + "name": "fw-group-example", + "description": "create a firewall group", + "ingress_firewall_policy_id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", + "admin_state_up": true + } +}+Response body of obtaining firewall_group_id: 102493e8-fc6d-4f0d-b57f-55c5be86f5c0.
+{ + "firewall_group": { + "id": "102493e8-fc6d-4f0d-b57f-55c5be86f5c0", + "name": "fw-group-example", + "project_id": "5f6387106c2048b589b369d96c2f23a2", + "tenant_id": "5f6387106c2048b589b369d96c2f23a2", + "admin_state_up": true, + "egress_firewall_policy_id": null, + "ingress_firewall_policy_id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", + "description": "create a firewall group", + "created_at": "2023-03-09T08:54:40", + "updated_at": "2023-03-09T08:54:40", + "status": "INACTIVE", + "ports": [], + "public": false + } +}+Log in to the network console and view the created firewall resources.
+ +
+
++ diff --git a/docs/vpc/api-ref/en-us_topic_0020090596.html b/docs/vpc/api-ref/en-us_topic_0020090596.html index 8acdada2..09d6072b 100644 --- a/docs/vpc/api-ref/en-us_topic_0020090596.html +++ b/docs/vpc/api-ref/en-us_topic_0020090596.html @@ -2,7 +2,11 @@++Parent topic: FAQs+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 bound to or unbound from ECSs, BMSs, virtual IP addresses, load balancers, and NAT gateways.
+The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be 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:+- In eu-de, EIPs of the Dedicated Load Balancer (5_gray) type cannot be assigned anymore. You can assign EIPs of the BGP (5_bgp) type.
- Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
- Do not add EIPs of the dedicated load balancer type (5_gray) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
Request Message
- Request parameter
-
Table 2 Request parameter Name
+Request Parameters
+Table 2 Request body parameter Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
publicip
+publicip
Yes
+Yes
publicip object
+publicip object
Specifies the EIP object. For details, see Table 3.
+Specifies the EIP object. For details, see Table 3.
bandwidth
+bandwidth
Yes
+Yes
bandwidth object
+bandwidth object
Specifies the bandwidth object. For details, see Table 4.
-enterprise_project_id
-No
-String
-- Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
- When you assign an EIP, associate an enterprise project ID with the EIP.
- If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
NOTE:+This parameter is unsupported. Do not use it.
-Specifies the bandwidth object. For details, see Table 4.
-Table 3 Description of the publicip field Name
+Table 3 Description of the publicip field Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
type
+type
Yes
+Yes
String
+String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated Load Balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
ip_address
+ip_version
No
+No
String
+Integer
- Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it.
- The value must be a valid IPv4 address in the available IP address range.
- Specifies the EIP version.
- The value can be 4 and 6, indicating IPv4 address and IPv6 address, respectively. IPv6 is not supported currently.
- Constraints:
- The configured value must be supported by the system.
- If this parameter is left blank or is an empty string, IPv4 address is created by default.
alias
+No
+String
+- Specifies the EIP name.
- The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
Table 4 Description of the bandwidth field Name
+- -Table 4 Description of the bandwidth field Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
name
+name
Yes
+Yes
String
+String
- Specifies the bandwidth name.
- The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- 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.
- Specifies the bandwidth name.
- The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- 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.
size
+size
Yes
+Yes
Integer
+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.
id
+id
No
+No
String
+String
- Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP.
- The value can be the ID of the shared bandwidth whose type is set to WHOLE.
- Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP.
- The value can be the ID of the shared bandwidth whose type is set to WHOLE.
share_type
+share_type
Yes
+Yes
String
+String
- Specifies the bandwidth type.
- Possible values are as follows:
- PER: Dedicated bandwidth
- WHOLE: Shared bandwidth
- Specifies the bandwidth type.
- Possible values are as follows:
- PER: Dedicated bandwidth
- WHOLE: Shared bandwidth
- If this parameter is set to WHOLE, the bandwidth ID must be specified.
charge_mode
+charge_mode
No
+No
String
+String
- The value is traffic, indicating that the billing is based on traffic.
- The value is traffic, indicating that the billing is based on traffic.
- Example request (IPv4 EIP with dedicated bandwidth)
POST https://{Endpoint}/v1/{project_id}/publicips + +Example Request
Example request (IPv4 EIP with dedicated bandwidth)POST https://{Endpoint}/v1/{project_id}/publicips { "publicip": { @@ -176,113 +179,133 @@ "name": "bandwidth123", "size": 10, "share_type": "PER" - }, - "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439" + } }- +Response Message
- Response parameter
-
Table 5 Response parameter Name
+-Table 5 Response parameter Name
Type
+Type
Description
+Description
publicip
+publicip
publicip object
+publicip object
Specifies the EIP object. For details, see Table 6.
+Specifies the EIP object. For details, see Table 6.
-Table 6 Description of the publicip field Name
+-Table 6 Description of the publicip field Name
Type
+Type
Description
+Description
id
+id
String
+String
Specifies the unique identifier of an EIP.
+Specifies the unique identifier of an EIP.
status
+status
String
+String
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- ERROR (Exceptions)
- Specifies the EIP status.
- Possible values are as follows:
- FREEZED (Frozen)
- BIND_ERROR (Binding failed)
- BINDING (Binding)
- PENDING_DELETE (Releasing)
- PENDING_CREATE (Assigning)
- PENDING_UPDATE (Updating)
- NOTIFYING (Assigning)
- NOTIFY_DELETE (Release)
- DOWN (Unbound)
- ACTIVE (Bound)
- ELB (Bound to a load balancer)
- VPN (Bound to a VPN)
- ERROR (Exceptions)
type
+type
String
+String
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated load balancer, shared load balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
- Specifies the EIP type.
- The value can be 5_bgp (Dynamic BGP), 5_mailbgp (Mail BGP), or 5_gray (Dedicated Load Balancer).
- Constraints:
- The configured value must be supported by the system.
- publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
public_ip_address
+public_ip_address
String
+String
Specifies the obtained EIP if only IPv4 EIPs are available.
+Specifies the obtained EIP if only IPv4 EIPs are available.
ip_version
+ip_version
Integer
+Integer
Specifies the IP address version. The value can be 4 or 6.
+Specifies the IP address version. The value can be 4 or 6.
- 4: IPv4
- 6: IPv6 (IPv6 is not supported currently.)
tenant_id
+tenant_id
String
+String
Specifies the project ID.
+Specifies the project ID.
create_time
+create_time
String
+String
Specifies the time (UTC) when the EIP is assigned.
+Specifies the time (UTC) when the EIP is assigned.
+Format: yyyy-MM-dd HH:mm:ss
bandwidth_size
+bandwidth_size
Integer
+Integer
Specifies the bandwidth (Mbit/s).
+Specifies the bandwidth (Mbit/s).
enterprise_project_id
+alias
String
+String
- Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
- When you assign an EIP, associate an enterprise project ID with the EIP.
- If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
NOTE:+This parameter is unsupported. Do not use it.
-Specifies the EIP name.
+enterprise_project_id
+String
+- Specifies the enterprise project ID. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-).
- When you assign an EIP, associate an enterprise project ID with the EIP.
- If this parameter is not specified, the default value is 0, which indicates that the default enterprise project is used.
public_border_group
+String
+Specifies whether it is in a central site or an edge site.
+The value can be:
+This resource can only be associated with an EIP of the same region.
+- Example response (IPv4 EIP with dedicated bandwidth)
+ +{ +Example Response
Example response (IPv4 EIP with dedicated bandwidth){ "publicip": { "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706", + "alias": "tom", + "public_border_group": "center", "status": "PENDING_CREATE", "type": "5_bgp", "public_ip_address": "161.xx.xx.7", @@ -290,10 +313,10 @@ "ip_version": 4, "create_time": "2015-07-16 04:10:52", "bandwidth_size": 0, - "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439" + "enterprise_project_id": "b261ac1f-2489-4bc7-b31b-c33c3346a439" } }- +@@ -302,7 +325,7 @@Status Code
See Status Codes.
diff --git a/docs/vpc/api-ref/permission_0001.html b/docs/vpc/api-ref/permission_0001.html new file mode 100644 index 00000000..09d4d6df --- /dev/null +++ b/docs/vpc/api-ref/permission_0001.html @@ -0,0 +1,17 @@ + + +-Parent topic: Elastic IP+Parent topic: EIPIntroduction
++By default, new IAM users do not have permissions assigned. You need to add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups. This way, they can perform specified operations on cloud services based on the permissions.
+Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query VPCs using an API, the user must have been granted permissions that allow the vpc:vpcs:list action.
++Supported Actions
VPC provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
+- Permissions: statements in a policy that allow or deny certain operations
- APIs: REST APIs that can be called by a user who has been granted specific permissions
- Actions: specific operations that are allowed or denied
- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be used and applied to IAM only. +
√: supported; x: not supported
+
++ diff --git a/docs/vpc/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/vpc/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be..37942803 100644 Binary files a/docs/vpc/api-ref/public_sys-resources/icon-arrowdn.gif and b/docs/vpc/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/vpc/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/vpc/api-ref/public_sys-resources/icon-arrowrt.gif index 39583d16..6aaaa11c 100644 Binary files a/docs/vpc/api-ref/public_sys-resources/icon-arrowrt.gif and b/docs/vpc/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/vpc/api-ref/subnet_tag_0001.html b/docs/vpc/api-ref/subnet_tag_0001.html index 74539e23..695db9ee 100644 --- a/docs/vpc/api-ref/subnet_tag_0001.html +++ b/docs/vpc/api-ref/subnet_tag_0001.html @@ -33,65 +33,65 @@++Parent topic: Permissions Policies and Supported Actions+Request Message
- Request parameter
Table 2 Request parameter Parameter
+-Request Parameters
+-Table 2 Request parameter Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
tag
+tag
tag object
+tag object
Yes
+Yes
Specifies the tag objects. For details, see Table 3.
+Specifies the tag objects. For details, see Table 3.
Table 3 tag objects Attribute
+-Table 3 tag objects Attribute
Type
+Type
Mandatory
+Mandatory
Description
+Description
key
+key
String
+String
Yes
+Yes
- Specifies the tag key.
- Cannot be left blank.
- Can contain a maximum of 36 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- The tag key of a VPC must be unique.
- Specifies the tag key.
- Cannot be left blank.
- Contain up to 128 characters (36 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- The tag key of a VPC must be unique.
value
+value
String
+String
Yes
+Yes
- Specifies the tag value.
- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- Specifies the tag value.
- Contain up to 255 characters (43 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- Example request
-Example Request
- Create a tag for a subnet. The key is key1, and the value is value1.
POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags { @@ -101,9 +101,9 @@ } }Response Message
++Response Parameters
None
+Example Response
None
diff --git a/docs/vpc/api-ref/subnet_tag_0002.html b/docs/vpc/api-ref/subnet_tag_0002.html index 32074961..97d7221b 100644 --- a/docs/vpc/api-ref/subnet_tag_0002.html +++ b/docs/vpc/api-ref/subnet_tag_0002.html @@ -33,61 +33,59 @@Status Code
See Status Codes.
Request Message
Request parameter
-None
-Example request
-GET https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags+-Request Parameters
None
-Response Message
Response parameter
- -Table 2 Response parameter Parameter
++Example Request
GET https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags+-Response Parameters
+-Table 2 Response parameter Parameter
Type
+Type
Description
+Description
tags
+tags
Array of tag objects
+Array of tag objects
Specifies the tag object list. For details, see Table 3.
+Specifies the tag object list. For details, see Table 3.
Table 3 tag objects Attribute
+-Table 3 tag objects Attribute
Type
+Type
Description
+Description
key
+key
String
+String
- Specifies the tag key.
- Cannot be left blank.
- Can contain a maximum of 36 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- The tag key of a VPC must be unique.
- Specifies the tag key.
- Cannot be left blank.
- Contain up to 128 characters (36 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- The tag key of a VPC must be unique.
value
+value
String
+String
- Specifies the tag value.
- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- Specifies the tag value.
- Contain up to 255 characters (43 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
Example response
-{ + +Example Response
{ "tags": [ { "key": "key1", diff --git a/docs/vpc/api-ref/subnet_tag_0003.html b/docs/vpc/api-ref/subnet_tag_0003.html index 52b3d28e..6127879a 100644 --- a/docs/vpc/api-ref/subnet_tag_0003.html +++ b/docs/vpc/api-ref/subnet_tag_0003.html @@ -40,15 +40,13 @@Request Message
Request parameter
-None
-Example request
-DELETE https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/{key}+-Request Parameters
None
Response Message
Response parameter
-None
-Example response
-None
++Example Request
DELETE https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/{key}++Response Parameters
None
+Example Response
None
diff --git a/docs/vpc/api-ref/subnet_tag_0004.html b/docs/vpc/api-ref/subnet_tag_0004.html index 9181fcb1..2f2a6c81 100644 --- a/docs/vpc/api-ref/subnet_tag_0004.html +++ b/docs/vpc/api-ref/subnet_tag_0004.html @@ -37,34 +37,33 @@Status Code
See Status Codes.
Request Message
Request parameter
- -Table 2 Request parameter Parameter
+-Request Parameters
+-Table 2 Request parameter Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
tags
+tags
Array of tag objects
+Array of tag objects
Yes
+Yes
Specifies the tag object list. For details, see Table 3.
+Specifies the tag object list. For details, see Table 3.
action
+action
String
+String
Yes
+Yes
Specifies the operation. Possible values are as follows:
+Specifies the operation. Possible values are as follows:
- create
- delete
Table 3 tag objects Attribute
+-Table 3 tag objects Attribute
Type
+Type
Mandatory
+Mandatory
Description
+Description
key
+key
String
+String
Yes
+Yes
- Specifies the tag key.
- Cannot be left blank.
- Can contain a maximum of 36 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- The tag key of a VPC must be unique.
- Specifies the tag key.
- Cannot be left blank.
- Contain up to 128 characters (36 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- The tag key of a VPC must be unique.
value
+value
String
+String
Yes
+Yes
- Specifies the tag value.
- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- Specifies the tag value.
- Contain up to 255 characters (43 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
Request example 1: Creating tags in batches
-POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action +Example Request
- Batch create two tags for a subnet.
POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action { "action": "create", @@ -122,8 +120,8 @@ } ] }-Request example 2: Deleting tags in batches
-POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action +
- Batch delete two tags for a subnet.
POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action { "action": "delete", @@ -138,10 +136,11 @@ } ] }-+Response Message
Response parameter
-None
-Example response
-None
+ ++Response Parameters
None
+Example Response
None
diff --git a/docs/vpc/api-ref/subnet_tag_0005.html b/docs/vpc/api-ref/subnet_tag_0005.html index ade6a2c6..e5272ef4 100644 --- a/docs/vpc/api-ref/subnet_tag_0005.html +++ b/docs/vpc/api-ref/subnet_tag_0005.html @@ -25,85 +25,93 @@Status Code
See Status Codes.
Request Message
Request parameter
- -Table 2 Request parameter Parameter
+Request Parameters
+Table 2 Request parameter Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
tags
+tags
Array of tag objects
+Array of tag objects
No
+No
Specifies the included tags. A maximum of 20 tag keys are allowed for each query operation. Each tag key can have up to 10 tag values. The structure body must be included. The tag key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique.
+Specifies the included tags. A maximum of 20 tag keys are allowed for each query operation. Each tag key can have up to 10 tag values. The structure body must be included. The tag key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique.
limit
+limit
Integer
+Integer
No
+No
Sets the page size. This parameter is not available when action is set to count. The default value is 1000 when action is set to filter. The maximum value is 1000, and the minimum value is 1. The value cannot be a negative number.
+Sets the page size. This parameter is not available when action is set to count. The default value is 1000 when action is set to filter. The maximum value is 1000, and the minimum value is 1. The value cannot be a negative number.
offset
+offset
Integer
+Integer
No
+No
Specifies the index position. The query starts from the next piece of data indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when action is set to count. If action is set to filter, the value must be a number, and the default value is 0. The value cannot be a negative number.
+Specifies the index position. The query starts from the next piece of data indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when action is set to count. If action is set to filter, the value must be a number, and the default value is 0. The value cannot be a negative number.
action
+action
String
+String
Yes
+Yes
Specifies the operation to perform. The value can only be filter (filtering) or count (querying the total number).
+Specifies the operation to perform. The value can only be filter (filtering) or count (querying the total number).
The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.
matches
+matches
Array of match objects
+Array of match objects
No
+No
Specifies the search criteria. The tag key is the field to match. Currently, only resource_name is supported. The tag value indicates the matched value. This field is a fixed dictionary value.
+Specifies the search criteria. The tag key is the field to match. Currently, only resource_name is supported. The tag value indicates the matched value. This field is a fixed dictionary value.
-Table 3 Description of the tag field Name
+Table 3 Description of the tag field Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+String
Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)
+Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)
+values
+Yes
+Array of strings
+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.
-Table 4 Description of the match field Name
+Table 4 Description of the match field Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+String
Specifies the tag key. Currently, the tag key can only be the resource name.
+Specifies the tag key. Currently, the tag key can only be the resource name.
value
+value
Yes
+Yes
String
+String
Specifies the tag value. Each value can contain a maximum of 255 Unicode characters.
+Specifies the tag value. Each value can contain a maximum of 255 Unicode characters.
Example request 1: Setting action to filterPOST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action +-Example Request
- Filter subnets by setting action to filter. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use matches and tags to filter subnets.
POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action { "offset": "0", @@ -166,8 +174,8 @@ } ] }-
Example request 2: Setting action to count-POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action + +- Count subnets by setting action to count. Use matches and tags to filter and count VPCs.
POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action { "action": "count", @@ -194,69 +202,69 @@ } ] }+
Response Message
Response parameter
- -Table 5 Response parameter Name
+Response Parameters
+Table 5 Response parameter Name
Type
+Type
Description
+Description
resources
+resources
Array of resource objects
+Array of resource objects
Specifies the resource object list. For details, see Table 6.
+Specifies the resource object list. For details, see Table 6.
total_count
+total_count
Integer
+Integer
Specifies the total number of query records.
+Specifies the total number of query records.
-Table 6 resource objects Name
+Table 6 resource objects Name
Type
+Type
Description
+Description
resource_id
+resource_id
String
+String
Specifies the resource ID.
+Specifies the resource ID.
resource_detail
+resource_detail
Object
+Object
Specifies the resource details. Resource details are used for extension. This parameter is left blank by default.
+Specifies the resource details. Resource details are used for extension. This parameter is left blank by default.
tags
+tags
Array of tag objects
+Array of tag objects
Specifies the tag list. This parameter is an empty array by default if there is no tag. For details, see Table 7.
+Specifies the tag list. This parameter is an empty array by default if there is no tag. For details, see Table 7.
resource_name
+resource_name
String
+String
Specifies the resource name. This parameter is an empty string by default if there is no resource name.
+Specifies the resource name. This parameter is an empty string by default if there is no resource name.
-Table 7 Description of the tag field Name
+-Table 7 Description of the tag field Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+String
Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)
+Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)
values
+value
Yes
+Yes
Array of strings
+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.
Example response 1: Setting action to filter
-{ + +Example Response
- When action is set to filter:
{ "resources": [ { "resource_detail": null, @@ -317,10 +325,11 @@ "total_count": 1000 }-Example response 2: Setting action to count
-{ +
- When action is set to count:
{ "total_count": 1000 }+
diff --git a/docs/vpc/api-ref/subnet_tag_0006.html b/docs/vpc/api-ref/subnet_tag_0006.html index e2cd7667..7f5e4af2 100644 --- a/docs/vpc/api-ref/subnet_tag_0006.html +++ b/docs/vpc/api-ref/subnet_tag_0006.html @@ -25,63 +25,61 @@Status Code
See Status Codes.
Request Message
Request parameter
-None
-Example request
-GET https://{Endpoint}/v2.0/{project_id}/subnets/tags+-Request Parameters
None
Response Message
Response parameter
- -Table 2 Response parameter Parameter
++Example Request
GET https://{Endpoint}/v2.0/{project_id}/subnets/tags+Response Parameters
+-Table 2 Response parameter Parameter
Type
+Type
Description
+Description
tags
+tags
Array of tag objects
+Array of tag objects
Specifies the tag object list. For details, see Table 3.
+Specifies the tag object list. For details, see Table 3.
Table 3 Description of the tag field Name
+-Table 3 Description of the tag field Name
Type
+Type
Description
+Description
key
+key
String
+String
Specifies the tag key.
-- Cannot be left blank.
- Can contain a maximum of 36 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
Specifies the tag key.
+- Cannot be left blank.
- Contain up to 128 characters (36 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
values
+values
Array of strings
+Array of strings
Specifies the tag value list.
-- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
Specifies the tag value list.
+- Contain up to 255 characters (43 characters on the console).
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
Example response
-{ + +-Example Response
{ "tags": [ { "key": "key1", diff --git a/docs/vpc/api-ref/vpc_api01_0001.html b/docs/vpc/api-ref/vpc_api01_0001.html index 9d81b429..d3d1abfa 100644 --- a/docs/vpc/api-ref/vpc_api01_0001.html +++ b/docs/vpc/api-ref/vpc_api01_0001.html @@ -25,85 +25,82 @@Request Message
- Request parameter
-
Table 2 Request parameter Name
+Request Parameters
+-Table 2 Request parameter Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
vpc
+vpc
Yes
+Yes
vpc object
+vpc object
+ Table 3 VPC objects Name
+- -Table 3 VPC objects Name
Mandatory
+Mandatory
Type
+Type
Description
+Description
name
+name
No
+No
String
+String
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
description
+description
No
+No
String
+String
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
cidr
+cidr
No
+No
String
+String
- Specifies the available IP address ranges for subnets in the VPC.
- Possible values are as follows:
- 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.
- Possible values are as follows:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- 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.
enterprise_project_id
+enterprise_project_id
No
+No
String
+String
- Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
NOTE:+This parameter is unsupported. Do not use it.
-- Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
- Example request
POST https://{Endpoint}/v1/{project_id}/vpcs +Example Request
- Create a VPC named vpc and set its CIDR block to 192.168.0.0/16.
POST https://{Endpoint}/v1/{project_id}/vpcs { "vpc": { @@ -114,125 +111,124 @@ } }
Response Message
- Response parameter
-
Table 4 Response parameter Name
+ +Response Parameters
+-Table 4 Response parameter Name
Type
+Type
Description
+Description
vpc
+vpc
vpc object
+vpc object
+ Table 5 VPC objects Name
+-Table 5 VPC objects Name
Type
+Type
Description
+Description
id
+id
String
+String
Specifies a resource ID in UUID format.
+Specifies a resource ID in UUID format.
name
+name
String
+String
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
description
+description
String
+String
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
cidr
+cidr
String
+String
- Specifies the available IP address ranges for subnets in the VPC.
- Possible values are as follows:
- 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.
- Possible values are as follows:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- 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.
status
+status
String
+String
- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
routes
+routes
Array of route objects
+Array of route objects
- Specifies the route information.
- For details, see the description of the route objects.
- Specifies the route information.
- For details, see the description of the route objects.
enable_shared_snat
+enable_shared_snat
Boolean
+Boolean
Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
+Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
enterprise_project_id
+enterprise_project_id
String
+String
- Specifies the enterprise project ID.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
NOTE:+This parameter is unsupported. Do not use it.
-- Specifies the enterprise project ID.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
Table 6 route objects Name
+- -Table 6 route objects Name
Type
+Type
Description
+Description
destination
+destination
String
+String
- Specifies the destination network segment of a route.
- The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
- Specifies the destination network segment of a route.
- The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
nexthop
+nexthop
String
+String
- Specifies the next hop of a route.
- The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
- Specifies the next hop of a route.
- The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
- Example response
{ + +Example Response
{ "vpc": { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", @@ -244,7 +240,6 @@ "routes": [] } }-diff --git a/docs/vpc/api-ref/vpc_api01_0002.html b/docs/vpc/api-ref/vpc_api01_0002.html index 7d1fb324..0657ad3a 100644 --- a/docs/vpc/api-ref/vpc_api01_0002.html +++ b/docs/vpc/api-ref/vpc_api01_0002.html @@ -32,130 +32,127 @@ -Status Code
See Status Codes.
Request Message
- Request parameter -
- Example request
GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3- -
-Request Parameters
None
Response Message
- Response parameter
-
Table 2 Response parameter Name
++Example Request
GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3+Response Parameters
+-Table 2 Response parameter Name
Type
+Type
Description
+Description
vpc
+vpc
vpc object
+vpc object
+ Table 3 VPC objects Name
+-Table 3 VPC objects Name
Type
+Type
Description
+Description
id
+id
String
+String
Specifies a resource ID in UUID format.
+Specifies a resource ID in UUID format.
name
+name
String
+String
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
description
+description
String
+String
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
cidr
+cidr
String
+String
- Specifies the available IP address ranges for subnets in the VPC.
- Possible values are as follows:
- 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.
- Possible values are as follows:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- 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.
status
+status
String
+String
- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
routes
+routes
Array of route objects
+Array of route objects
- Specifies the route information.
- For details, see the description of the route objects.
- Specifies the route information.
- For details, see the description of the route objects.
enable_shared_snat
+enable_shared_snat
Boolean
+Boolean
Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
+Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
enterprise_project_id
+enterprise_project_id
String
+String
- Specifies the enterprise project ID.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.NOTE:-
This parameter is unsupported. Do not use it.
-
- Enterprise project ID
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
Table 4 route objects Name
+- -Table 4 route objects Name
Type
+Type
Description
+Description
destination
+destination
String
+String
- Specifies the destination network segment of a route.
- The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
- Specifies the destination network segment of a route.
- The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
nexthop
+nexthop
String
+String
- Specifies the next hop of a route.
- The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
- Specifies the next hop of a route.
- The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
- Example response
+
Example Response
-{ "vpc": { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name": "vpc", @@ -168,7 +165,6 @@ } }diff --git a/docs/vpc/api-ref/vpc_api01_0003.html b/docs/vpc/api-ref/vpc_api01_0003.html index 4439b574..00b8f351 100644 --- a/docs/vpc/api-ref/vpc_api01_0003.html +++ b/docs/vpc/api-ref/vpc_api01_0003.html @@ -34,7 +34,7 @@Status Code
See Status Codes.
Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.
This parameter can work together with the parameter limit.
-- If parameters marker and limit are not passed, all resource records will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
- If parameters marker and limit are not passed, resource records on the first page will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
limit
@@ -43,7 +43,7 @@Integer
Specifies the number of records that will be returned on each page. The value is from 0 to intmax.
+Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000.
limit can be used together with marker. For details, see the parameter description of marker.
String
- Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps.NOTE:-
This parameter is unsupported. Do not use it.
-
- Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps.
- If this parameter is not specified, VPCs in the default enterprise project are queried and are authenticated based on the default enterprise project.
Request Message
+-Request Parameters
None
Response Message
- Response parameter
-
Table 2 Response parameter Name
++Example Request
GET https://{Endpoint}/v1/{project_id}/vpcs+Response Parameters
+-Table 2 Response parameter Name
Type
+Type
Description
+Description
vpcs
+vpcs
Array of vpcs objects
+Array of vpcs objects
Specifies the VPCs.
+Specifies the VPCs.
Table 3 Description of the vpcs field Name
+-Table 3 Description of the vpcs field Name
Type
+Type
Description
+Description
id
+id
String
+String
Specifies a resource ID in UUID format.
+Specifies a resource ID in UUID format.
name
+name
String
+String
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
- Specifies the VPC name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
description
+description
String
+String
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
- Provides supplementary information about the VPC.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
cidr
+cidr
String
+String
- Specifies the available IP address ranges for subnets in the VPC.
- Possible values are as follows:
- 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.
- Possible values are as follows:
- 10.0.0.0/8-24
- 172.16.0.0/12-24
- 192.168.0.0/16-24
- 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.
status
+status
String
+String
- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
enterprise_project_id
+enterprise_project_id
String
+String
- Specifies the enterprise project ID.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.NOTE:-
This parameter is unsupported. Do not use it.
-
- Specifies the enterprise project ID.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
routes
+routes
Array of route objects
+Array of route objects
- Specifies the route information.
- For details, see Table 4.
- Specifies the route information.
- For details, see Table 4.
enable_shared_snat
+enable_shared_snat
Boolean
+Boolean
Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
+Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
Table 4 route objects Name
+- -Table 4 route objects Name
Type
+Type
Description
+Description
destination
+destination
String
+String
- Specifies the destination network segment of a route.
- The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
- Specifies the destination network segment of a route.
- The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
nexthop
+nexthop
String
+String
- Specifies the next hop of a route.
- The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
- Specifies the next hop of a route.
- The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
- Example response
{ + +Example Response
{ "vpcs": [ { "id": "13551d6b-755d-4757-b956-536f674975c0", @@ -219,7 +215,6 @@ } ] }-diff --git a/docs/vpc/api-ref/vpc_api01_0004.html b/docs/vpc/api-ref/vpc_api01_0004.html index af7b32bb..e8434e08 100644 --- a/docs/vpc/api-ref/vpc_api01_0004.html +++ b/docs/vpc/api-ref/vpc_api01_0004.html @@ -32,84 +32,86 @@ -Status Code
See Status Codes.
Request Message
- Request parameter
-
Table 2 Request parameter Name
+Request Parameters
+
- Request parameter
-
- Create a VPC named vpc and set its CIDR block to 192.168.0.0/16.
- Response parameter
-
- Request parameter
+
Creating a Tag for an EIP
-Function
This API is used to create a tag for an EIP.
+Creating a Tag for an EIP
+Function
This API is used to create a tag for an EIP.
URI
POST /v2.0/{project_id}/publicips/{publicip_id}/tags
Table 1 describes the parameters.
diff --git a/docs/vpc/api-ref/eip_tag_0002.html b/docs/vpc/api-ref/eip_tag_0002.html index e9b9ef28..d6aca4fd 100644 --- a/docs/vpc/api-ref/eip_tag_0002.html +++ b/docs/vpc/api-ref/eip_tag_0002.html @@ -1,38 +1,38 @@ -Querying EIP Tags
-Function
This API is used to query tags of a specified EIP.
+Querying EIP Tags
+Function
This API is used to query tags of a specified EIP.
URI
GET /v2.0/{project_id}/publicips/{publicip_id}/tags
-Table 1 describes the parameters.
+Table 1 describes the parameters.
-Name +
Request Message |
|---|