Error Codes
See Error Codes.
diff --git a/docs/vpc/api-ref/eip_tag_0000.html b/docs/vpc/api-ref/eip_tag_0000.html index a698ae79..cd5fd51c 100644 --- a/docs/vpc/api-ref/eip_tag_0000.html +++ b/docs/vpc/api-ref/eip_tag_0000.html @@ -4,13 +4,13 @@-
-
- Creating a Tag for an EIP
+ - Adding a Tag to an EIP
- Querying EIP Tags
- - Deleting an EIP Tag
+ - Deleting a Tag from an EIP
- - Batch Creating or Deleting EIP Tags
+ - Batch Adding or Deleting EIP Tags
- Querying EIPs by Tag
diff --git a/docs/vpc/api-ref/eip_tag_0001.html b/docs/vpc/api-ref/eip_tag_0001.html
index 6575eff7..b14582de 100644
--- a/docs/vpc/api-ref/eip_tag_0001.html
+++ b/docs/vpc/api-ref/eip_tag_0001.html
@@ -1,12 +1,12 @@
- - 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.
- Can contain a maximum of 36 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-), underscores (_), and at signs (@)
- The tag key of a VPC must be unique.
- 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.
- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-), underscores (_), and at signs (@)
URI
GET /v2.0/{project_id}/publicips/{publicip_id}/tags
Table 1 describes the parameters.
-Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
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.
- Can contain a maximum of 36 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-), underscores (_), and at signs (@)
- The tag key of a VPC must be unique.
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.
- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-), underscores (_), and at signs (@)
Deleting an EIP Tag
-Function
This API is used to delete an EIP tag.
+Deleting a Tag from an EIP
+Function
This API is used to delete a tag from an EIP.
URI
DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
Table 1 describes the parameters.
-Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
Batch Creating or Deleting EIP Tags
+Batch Adding 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.
@@ -10,7 +10,7 @@URI
POST /v2.0/{project_id}/publicips/{publicip_id}/tags/action
Table 1 describes the parameters.
-Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
Mandatory
Description
+Description
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 (_)
- 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 (-), underscores (_), and at signs (@)
- The tag key of a VPC must be unique.
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.
- Can contain a maximum of 43 characters.
- Can contain only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-), underscores (_), and at signs (@)
URI
POST /v2.0/{project_id}/publicips/resource_instances/action
Table 1 describes the parameters.
-Table 1 Parameter description Name
+-Table 3 Description of the tags field Name
+Table 3 Description of the tags field Parameter
Mandatory
Type
Description
+Description
-Table 4 Description of the match field Name
+Table 4 Description of the match field Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Response Message
- Response parameter
-
Table 5 Response parameter Name
+Table 5 Response parameter Parameter
Type
+Type
Description
+Description
-Table 6 resource objects Name
+Table 6 resource objects Parameter
Type
+Type
Description
+Description
Table 7 Description of the tags field Name
+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.
URI
GET /v2.0/{project_id}/publicips/tags
Table 1 describes the parameters.
-Table 1 Parameter description Name
+ -Table 3 Description of the tag field Name
+Table 3 Description of the tag field Parameter
Type
Description
+Description
String
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 (_)
- 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 (-), underscores (_), and at signs (@)
Array of strings
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 (_)
- 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 (-), underscores (_), and at signs (@)
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, 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.
The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSss, 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, 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.
URI
POST /v1/{project_id}/publicips
Table 1 describes the parameters. -Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
Request Parameters
-Table 2 Request body parameter Name
+Table 2 Request body parameter Parameter
Mandatory
-Table 3 Description of the publicip field Name
+Table 3 Description of the publicip field Parameter
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).
- 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), 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.
ip_version
+ip_version
No
+No
Integer
+Integer
- 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.
- 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
+alias
No
+No
String
+String
- Specifies the EIP name.
- The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- 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 Parameter
Mandatory
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.
String
- The value is traffic, indicating that the billing is based on traffic.
- Specifies whether the bandwidth is billed by traffic or by bandwidth size.
- The value is traffic, indicating that the billing is based on traffic.
Response Message
- Response parameter
-
Table 5 Response parameter Name
+-Table 5 Response parameter Parameter
Type
Table 6 Description of the publicip field Name
+Table 6 Description of the publicip field Parameter
Type
String
- 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.
- 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.
Introduction
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.
+An 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. diff --git a/docs/vpc/api-ref/subnet_tag_0000.html b/docs/vpc/api-ref/subnet_tag_0000.html index 9a667543..dcbfc057 100644 --- a/docs/vpc/api-ref/subnet_tag_0000.html +++ b/docs/vpc/api-ref/subnet_tag_0000.html @@ -4,13 +4,13 @@
√: supported; x: not supported
+- 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 project/Enterprise project: A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management.
√: supported; x: not supported
-
-
- Creating a Tag for a Subnet
+ - Adding a Tag to a Subnet
- Querying Subnet Tags
- - Deleting a Subnet Tag
+ - Deleting a Tag from a Subnet
- - Batch Creating or Deleting Subnet Tags
+ - Batch Adding or Deleting Subnet Tags
- Querying Subnets by Tag
diff --git a/docs/vpc/api-ref/subnet_tag_0001.html b/docs/vpc/api-ref/subnet_tag_0001.html
index 695db9ee..5c10b238 100644
--- a/docs/vpc/api-ref/subnet_tag_0001.html
+++ b/docs/vpc/api-ref/subnet_tag_0001.html
@@ -1,12 +1,12 @@
- - 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 (_)
- 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 (-), underscores (_), and at signs (@)
- The tag key of a VPC must be unique.
- 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 (_)
- 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 (-), underscores (_), and at signs (@)
URI
GET /v2.0/{project_id}/subnets/{subnet_id}/tags
Table 1 describes the parameters.
-Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
Yes
Specifies the subnet ID, which uniquely identifies the subnet.
+Specifies the subnet ID that uniquely identifies the subnet.
If you use the management console, the value of this parameter is the Network ID value.
String
- 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 (_)
- 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 (-), underscores (_), and at signs (@)
- The tag key of a VPC must be unique.
String
- 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 (_)
- 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 (-), underscores (_), and at signs (@)
Deleting a Subnet Tag
-Function
This API is used to delete a subnet tag.
+Deleting a Tag from a Subnet
+Function
This API is used to delete a tag from subnet.
URI
DELETE /v2.0/{project_id}/subnets/{subnet_id}/tags/{key}
Table 1 describes the parameters.
-Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
Batch Creating or Deleting Subnet Tags
+Batch Adding or Deleting Subnet Tags
Function
This API is used to add multiple tags to or delete multiple tags from a subnet at a time.
This API is idempotent.
If there are duplicate keys in the request body when you add tags, an error is reported.
@@ -10,7 +10,7 @@URI
POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action
Table 1 describes the parameters.
-Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
Yes
- 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 (_)
- 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 (-), underscores (_), and at signs (@)
- The tag key of a VPC must be unique.
Yes
- 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 (_)
- 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 (-), underscores (_), and at signs (@)
URI
POST /v2.0/{project_id}/subnets/resource_instances/action
Table 1 describes the parameters.
-
Creating a Tag for a Subnet
-Function
This API is used to create a tag for a subnet.
+Adding a Tag to a Subnet
+Function
This API is used to add a tag to a subnet.
URI
POST /v2.0/{project_id}/subnets/{subnet_id}/tags
Table 1 describes the parameters.
-Table 1 Parameter description Name
+Table 1 Parameter description Parameter
Mandatory
Yes
Yes
Creating a Tag for an EIP
-Function
This API is used to create a tag for an EIP.
+Adding a Tag to an EIP
+Function
This API is used to add a tag to an EIP.
URI
POST /v2.0/{project_id}/publicips/{publicip_id}/tags
Table 1 describes the parameters.
-Name +
|
|---|