Queries customer gateways.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vpc:DescribeCustomerGateways | list |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region where the customer gateway is deployed. You can call the DescribeRegions operation to query the most recent region list. | cn-shanghai |
CustomerGatewayId | string | No | The ID of the customer gateway. Note
If you do not specify a customer gateway ID, the system queries all customer gateways in the current region by default.
| cgw-bp1pvpl9r9adju6l5**** |
PageNumber | integer | No | The page number. Default value: 1. | 1 |
PageSize | integer | No | The number of entries per page. Maximum value: 50. Default value: 10. | 10 |
Tag | array<object> | No | The tags to be added to the customer gateway. | |
object | No | |||
Key | string | No | The key of the tag. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain You can specify at most 20 tag keys at a time. | TagKey |
Value | string | No | The value of the tag. The tag value can be up to 128 characters in length. It can be an empty string. It cannot start with Each tag key corresponds to one tag value. You can specify at most 20 tag values at a time. | TagValue |
ResourceGroupId | string | No | The ID of the resource group to which the customer gateway belongs. You can call the ListResourceGroups operation to query the resource group list. | rg-acfmzs372yg**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"PageSize": 10,
"RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
"PageNumber": 1,
"TotalCount": 1,
"CustomerGateways": {
"CustomerGateway": [
{
"IpAddress": "139.32.XX.XX",
"Asn": 65530,
"Description": "desctest",
"CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
"CreateTime": 1492747187000,
"Name": "nametest",
"AuthKey": "AuthKey****",
"Tags": {
"Tag": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
},
"ResourceGroupId": "rg-acfmzs372yg****"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | The tag resources are duplicate. |
400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | The number of tags has reached the upper limit. |
400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | The error message returned because the specified tag value is invalid. |
400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | The error message returned because the specified tag key is invalid. |
400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | The error message returned because the specified tag key already exists. |
403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again. |
403 | Forbidden | User not authorized to operate on the specified resource. | You do not have the permissions to manage the specified resource. Apply for the permissions and try again. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-10-19 | API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |