tencent cloud

Feedback

DescribeAssistantCidr

Last updated: 2023-08-23 14:11:11

1. API Description

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

This API is used to query the list of secondary CIDR blocks.

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: DescribeAssistantCidr.
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 ID of a VPC instance set, such as vpc-6v2ht8q5.
Filters.N No Array of Filter Filter condition. VpcIds and Filters cannot be specified at the same time.
  • vpc-id - String - (Filter condition) VPC instance ID, such as vpc-f49l6u0z.
  • Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    AssistantCidrSet Array of AssistantCidr A set of eligible secondary CIDR blocks
    Note: This field may return null, indicating that no valid value was found.
    TotalCount Integer Number of eligible instances.
    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 secondary CIDR blocks

    This example shows you how to query the list of secondary CIDR blocks.

    Input Example

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

    Output Example

    {
        "Response": {
            "AssistantCidrSet": [
                {
                    "VpcId": "vpc-12345678",
                    "CidrBlock": "172.16.0.0/16",
                    "AssistantType": 0,
                    "SubnetSet": []
                }
            ],
            "TotalCount": 1,
            "RequestId": "c65ffbe5-512a-44fd-9611-99d12f4e565d"
        }
    }
    

    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.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.