tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
消息队列 CKafka 版
    文档
    Download PDF

    DescribeRegion

    最后更新时间：2023-07-05 15:57:43
    下载PDF

    1. API Description

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

    This API is used to enumerate regions, and can be called only in Guangzhou.

    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: DescribeRegion.
    Version Yes String Common Params. The value used for this API: 2019-08-19.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    Offset No Integer The offset value
    Limit No Integer The maximum number of results returned
    Business No String Business field, which can be ignored.
    CdcId No String CDC business field, which can be ignored.

    3. Output Parameters

    Parameter Name Type Description
    Result Array of Region List of the returned results of enumerated regions
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Enumerating regions

    Input Example

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

{
    "Business": "10"
}

    Output Example

    {
    "Response": {
        "Result": [
            {
                "RegionId": 8,
                "RegionName": "Beijing",
                "AreaName": "North China",
                "RegionCode": "bj",
                "RegionCodeV3": "ap-beijing"
            },
            {
                "RegionId": 16,
                "RegionName": "Chengdu",
                "AreaName": "Southwest China",
                "RegionCode": "cd",
                "RegionCodeV3": "ap-chengdu"
            },
            {
                "RegionId": 19,
                "RegionName": "Chongqing",
                "AreaName": "Southwest China",
                "RegionCode": "cq",
                "RegionCodeV3": "ap-chongqing"
            },
            {
                "RegionId": 5,
                "RegionName": "Hong Kong (China)",
                "AreaName": "Southeast Asia",
                "RegionCode": "hk",
                "RegionCodeV3": "ap-hongkong"
            },
            {
                "RegionId": 9,
                "RegionName": "Singapore",
                "AreaName": "Southeast Asia",
                "RegionCode": "sg",
                "RegionCodeV3": "ap-singapore"
            },
            {
                "RegionId": 21,
                "RegionName": "Mumbai",
                "AreaName": "Asia Pacific",
                "RegionCode": "in",
                "RegionCodeV3": "ap-mumbai"
            },
            {
                "RegionId": 25,
                "RegionName": "Tokyo",
                "AreaName": "Asia Pacific",
                "RegionCode": "jp",
                "RegionCodeV3": "ap-tokyo"
            },
            {
                "RegionId": 6,
                "RegionName": "Toronto",
                "AreaName": "North America",
                "RegionCode": "ca",
                "RegionCodeV3": "na-toronto"
            },
            {
                "RegionId": 15,
                "RegionName": "Silicon Valley",
                "AreaName": "West US",
                "RegionCode": "usw",
                "RegionCodeV3": "na-siliconvalley"
            },
            {
                "RegionId": 22,
                "RegionName": "Ashburn",
                "AreaName": "East US",
                "RegionCode": "use",
                "RegionCodeV3": "na-ashburn"
            }
        ],
        "RequestId": "fe2ba3b1-90bb-425d-abd4-08a62d0c3686"
    }
}

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue.InstanceNotExist The instance does not exist.
    InvalidParameterValue.RepetitionValue The parameter already exists.
    InvalidParameterValue.SubnetIdInvalid Invalid subnet ID.
    InvalidParameterValue.SubnetNotBelongToZone The subnet is not in the zone.
    InvalidParameterValue.VpcIdInvalid Invalid VPC ID.
    InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
    InvalidParameterValue.ZoneNotSupport The zone is not supported.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation Unauthorized operation.
    UnsupportedOperation.BatchDelInstanceLimit The batch instance deletion limit is reached.
    UnsupportedOperation.OssReject Oss rejected the operation.
    联系我们

    联系我们，为您的业务提供专属服务。

    联系我们
    技术支持

    如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

    提交工单
    7x24 电话支持
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款