tencent cloud

Feedback

Getting Server IP Addresses

Last updated: 2022-03-29 16:44:11

    Feature Description

    Sometimes, you may need to obtain the list of server IP addresses for security purposes. This API is used by the app admin to obtain the list of server IP addresses or IP ranges used by the SDK and third-party callbacks.

    Overview

    Note:

    This API only supports obtaining the IP address or IP range information of IM integration methods in specified regions (countries). If you call it in other regions, a cache node will be connected by default. To obtain the IP address or IP range information of the cache node, contact us to enable this feature. We will assess your needs based on your application and enable this feature for you if appropriate.

    API Calling Description

    Sample request URL

    https://xxxxxx/v4/ConfigSvc/GetIPList?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
    

    Request parameters

    The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.

    Parameter Description
    https The request protocol is HTTPS, and the request method is POST.
    xxxxxx The country/region where your SDKAppID is located.
  • China: console.tim.qq.com
  • Singapore: adminapisgp.im.qcloud.com
  • Seoul: adminapikr.im.qcloud.com
  • Frankfurt: adminapiger.im.qcloud.com
  • India: adminapiind.im.qcloud.com
  • v4/ConfigSvc/GetIPList Request API
    sdkappid SDKAppID assigned by the IM console when the application is created
    identifier The value must be the app admin account. For more information, see App Admins.
    usersig Signature generated by the app admin account. For details, see Generating UserSig.
    random A random 32-bit unsigned integer ranging from 0 to 4294967295
    contenttype Request format. The value is always json.

    Maximum calling frequency

    The maximum calling frequency is 200 calls per second.

    Sample request packet

    {}
    

    Sample response packet body

    {
      "ActionStatus": "OK",
      "ErrorCode": 0,
      "IPList": [ "127.0.0.2",   "183.192.202.0/25" ]
    }
    

    Response packet fields

    Field Type Description
    IPList Array List of server IP addresses
    ErrorCode Integer Error code. 0 indicates that the request was successful, and any non-zero value indicates that the request failed.
    ErrorInfo String Detailed error information

    Error Codes

    Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response packet fields such as ErrorCode and ErrorInfo.
    For public error codes (60000 to 79999), see Error Codes.

    API Debugging Tool

    Use the online debugging tool for RESTful APIs to debug this API.

    Contact Us

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

    Technical Support

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

    7x24 Phone Support