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.
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.
https://xxxxxx/v4/ConfigSvc/GetIPList?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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.console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com 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 . |
The maximum calling frequency is 200 calls per second.
{}
{
"ActionStatus": "OK",
"ErrorCode": 0,
"IPList": [ "127.0.0.2", "183.192.202.0/25" ]
}
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 |
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.
Use the online debugging tool for RESTful APIs to debug this API.
Was this page helpful?