tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    DescribeVpcs

    Last updated: 2023-08-23 14:20:57
    Download PDF

      1. API Description

      Domain name for API request: vpc.tencentcloudapi.com.

      This API (DescribeVpcs) is used to query the VPC list.

      A maximum of 100 requests can be initiated per second for this API.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common Params. The value used for this API: DescribeVpcs.
      Version Yes String Common Params. The value used for this API: 2017-03-12.
      Region No String Common Params. This parameter is not required for this API.
      VpcIds.N No Array of String The VPC instance ID, such as vpc-f49l6u0z. Each request supports a maximum of 100 instances. VpcIds and Filters cannot be specified at the same time.
      Filters.N No Array of Filter Filter condition. VpcIds and Filters cannot be specified at the same time.
      Valid filters include:
    • vpc-name: VPC instance name, which supports fuzzy search.
    • is-default: Indicates whether it is the default VPC
    • vpc-id: VPC instance ID, such as vpc-f49l6u0z
    • cidr-block: VPC CIDR block
    • tag-key: (Optional) tag key
    • tag:tag-key: (Optional) tag key-value pair. Replace the tag-key with a specified tag value. For its usage, refer to Example 2.

      • Note: If one filter has multiple values, the logical relationship between these values is OR. The logical relationship between filters is AND.
      Offset No String Offset. Default value: 0.
      Limit No String Number of returned results. Default value: 20. Maximum value: 100.

      3. Output Parameters

      Parameter Name Type Description
      TotalCount Integer The number of objects meeting the condition.
      VpcSet Array of Vpc The VPC object.
      RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

      4. Example

      Example1 Querying the list of VPCs

      This example shows you how to query the list of VPCs.

      Input Example

      POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpcs
<Common request parameters>

{
    "Limit": "2",
    "Filters": [
        {
            "Values": [
                "192.168.0.0",
                "10.0.0.0"
            ],
            "Name": "cidr-block"
        },
        {
            "Values": [
                "false"
            ],
            "Name": "is-default"
        }
    ],
    "Offset": "0"
}

      Output Example

      {
    "Response": {
        "VpcSet": [
            {
                "VpcId": "vpc-p5sf61yj",
                "VpcName": "Test dhcp",
                "CidrBlock": "10.0.0.0/16",
                "Ipv6CidrBlock": "3402:4e00:20:1200::/56",
                "IsDefault": false,
                "EnableMulticast": false,
                "CreatedTime": "2018-04-25 10:26:26",
                "EnableDhcp": true,
                "DhcpOptionsId": "dopt-8g7k5qfq",
                "DnsServerSet": [
                    "10.0.0.1",
                    "183.60.82.98"
                ],
                "DomainName": "aa.bb.cc",
                "TagSet": [],
                "AssistantCidrSet": []
            }
        ],
        "TotalCount": 1,
        "RequestId": "6a44afb7-0644-4ff9-9761-3502f99d3a15"
    }
}

      Example2 Querying the list of VPCs bound to a tag

      This example shows you how to query VPCs bound to the tag city:shanghai.

      Input Example

      POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpcs
<Common request parameters>

{
    "Limit": "2",
    "Filters": [
        {
            "Values": [
                "shanghai"
            ],
            "Name": "tag:city"
        }
    ],
    "Offset": "0"
}

      Output Example

      {
    "Response": {
        "VpcSet": [
            {
                "VpcId": "vpc-p5sf61yj",
                "VpcName": "Test dhcp",
                "CidrBlock": "10.0.0.0/16",
                "Ipv6CidrBlock": "3402:4e00:20:1200::/56",
                "IsDefault": false,
                "EnableDhcp": true,
                "EnableMulticast": false,
                "CreatedTime": "2018-04-25 10:26:26",
                "DhcpOptionsId": "dopt-8g7k5qfq",
                "DnsServerSet": [
                    "10.0.0.1",
                    "183.60.82.98"
                ],
                "TagSet": [
                    {
                        "Key": "city",
                        "Value": "shanghai"
                    }
                ],
                "AssistantCidrSet": [
                    {
                        "CidrBlock": "192.168.1.0/24",
                        "AssistantType": 0,
                        "SubnetSet": []
                    }
                ],
                "DomainName": "aa.bb.cc"
            }
        ],
        "TotalCount": 1,
        "RequestId": "6a44afb7-0644-4ff9-9761-3502f99d3a15"
    }
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

      Error Code Description
      InternalError.ModuleError Internal module error
      InvalidParameter.Coexist The parameters cannot be specified at the same time.
      InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
      InvalidParameter.FilterNotDict The specified filter condition should be a key-value pair.
      InvalidParameter.FilterValuesNotList The specified filter value should be a list.
      InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
      InvalidParameterValue.Malformed Invalid input parameter format.
      InvalidParameterValue.Range The parameter value is not in the specified range.
      ResourceNotFound The resource does not exist.
      UnsupportedOperation Unsupported operation.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy