tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCustomerUin

Last updated: 2024-02-18 11:09:54

    1. API Description

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

    This API is used to query the list of customer UINs.

    A maximum of 20 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: DescribeCustomerUin.
    Version Yes String Common Params. The value used for this API: 2022-09-28.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    Page Yes Integer Page number
    PageSize Yes Integer Number of data entries per page

    3. Output Parameters

    Parameter Name Type Description
    Data Array of DescribeCustomerUinData List of customer UINs Note: This field may return null, indicating that no valid values can be obtained.
    Total String The number of customers
    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 customer UINs

    This example shows you how to query the list of customer UINs.

    Input Example

    POST / HTTP/1.1Host: intlpartnersmgt.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeCustomerUin<Common request parameters>{    "Page": 1,    "PageSize": 10}

    Output Example

    {
    "Response": {
        "Data": [
            {
                "CustomerUin": "123"
            }
        ],
        "Total": "123",
        "RequestId": "abc"
    }
}

    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
    InvalidParameter.Page Incorrect page parameter value.
    OperationDenied.ServiceBusy System busy. Please try again later.
    UnauthorizedOperation.UinNoAuth The current user doesn’t have permission for the operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy