Last updated: 2020-03-06 20:45:39

    1. API Description

    Domain name for API request:

    This API (DescribePaiInstances) is used to query the information of PAI instances.

    • You can query the detailed information of PAI instances based on information such as instance ID and instance domain name. For more information on filters, see Filter.
    • If the parameter is empty, a certain number (specified by Limit and 20 by default) of PAI instances of the current user will be returned.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

    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 parameter. The value used for this API: DescribePaiInstances.
    Version Yes String Common parameter. The value used for this API: 2018-04-19.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceIds.N No Array of String Queries by PAI instance ID.
    Filters.N No Array of Filter Filter.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
    Offset No Integer Offset. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible PAI instances
    PaiInstanceSet Array of PaiInstance PAI instance details
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying PAI Instances

    Query by PAI instance ID

    Input Example
    &<common request parameters>

    Output Example

      "Response": {
        "TotalCount": 2,
        "PaiInstanceSet": [
            "InstanceId": "ins-6he2sztp",
            "BindingIp": "",
            "DomainNameStatus": "ENABLED",
            "PaiMateUrl": "",
            "DomainName": ""
            "InstanceId": "ins-0xdrree5",
            "BindingIp": "",
            "DomainNameStatus": "ENABLED",
            "PaiMateUrl": "",
            "DomainName": ""
        "RequestId": "61a4c56f-c216-42f0-8238-eeabe338633e"

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback