DescribeIPStrategyApisStatus

Focus Mode

Font Size

Last updated: 2025-10-30 21:27:34

1. API Description

Domain name for API request: apigateway.intl.tencentcloudapi.com.

This API is used to query the list of APIs to which an IP policy can be bound, i.e., the difference set between all APIs under the service and the APIs already bound to the policy.

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: DescribeIPStrategyApisStatus.
Version	Yes	String	Common Params. The value used for this API: 2018-08-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ServiceId	Yes	String	Unique service ID.
StrategyId	Yes	String	Unique policy ID.
EnvironmentName	Yes	String	Policy environment.
Limit	No	Integer	Number of results to be returned. Default value: 20. Maximum value: 100.
Offset	No	Integer	Offset. Default value: 0.
Filters.N	No	Array of Filter	Filter. Valid values: ApiPath, ApiName, KeyWord (fuzzy search by `Path` and `Name`).

3. Output Parameters

Parameter Name	Type	Description
Result	IPStrategyApiStatus	List of APIs bound to environment. Note: this field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying APIs bound to a policy

Input Example

https://apigateway.intl.tencentcloudapi.com/?Action=DescribeIPStrategyApisStatus
&StrategyId=IPStrategy-0ez0c8to
&EnvironmentName=test
&ServiceId=service-ody35h5e
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "ApiIdStatusSet": [
                {
                    "OtherEnvironmentName": "xx",
                    "ApiId": "xx",
                    "ApiType": "xx",
                    "ApiName": "xx",
                    "OtherIPStrategyId": "xx",
                    "Path": "xx",
                    "Method": "xx"
                }
            ]
        },
        "RequestId": "xx"
    }
}

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

Tencent Cloud CLI 3.0

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.FormatError	Incorrect parameter format.
ResourceNotFound.InvalidIPStrategy	The IP policy does not exist.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

API Gateway