DescribeBindingPolicyObjectList

Download PDF

DescribeBindingPolicyObjectList

Last updated: 2023-08-11 16:09:23

Download PDF

1. API Description

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

This API is used to get the bound object list.

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: DescribeBindingPolicyObjectList.
Version	Yes	String	Common Params. The value used for this API: 2018-07-24.
Region	No	String	Common Params. This parameter is not required.
Module	Yes	String	The value is fixed to monitor.
GroupId	Yes	Integer	Policy group ID. If the ID is in the format of “policy-xxxx”, please enter it in the `PolicyId` field. Enter 0 in this field.
PolicyId	No	String	Alarm policy ID in the format of “policy-xxxx”. If a value has been entered in this field, you can enter 0 in the `GroupId` field.
Limit	No	Integer	The number of alarm objects returned each time. Value range: 1-100. Default value: 20.
Offset	No	Integer	Offset, which starts from 0 and is set to 0 by default. For example, the parameter `Offset=0&Limit=20` returns the zeroth to 19th alarm objects, and `Offset=20&Limit=20` returns the 20th to 39th alarm objects, and so on.
Dimensions.N	No	Array of DescribeBindingPolicyObjectListDimension	Dimensions of filtering objects.

3. Output Parameters

Parameter Name	Type	Description
List	Array of DescribeBindingPolicyObjectListInstance	List of bound object instances. Note: This field may return null, indicating that no valid value was found.
Total	Integer	Total number of bound object instances.
NoShieldedSum	Integer	Number of object instances that are not shielded.
InstanceGroup	DescribeBindingPolicyObjectListInstanceGroup	Bound instance group information. This parameter is not configured if no instance group is bound. Note: This field may return null, indicating that no valid value was found.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of bound objects

Input Example

https://monitor.tencentcloudapi.com/?Action=DescribeBindingPolicyObjectList
&Module=monitor
&GroupId=0
&PolicyId=policy-xxxxx
&<common request parameters>

Output Example

{
    "Response": {
        "List": [
            {
                "Dimensions": "{\"unInstanceId\":\"ins-19701111\"}",
                "IsShielded": 0,
                "Region": "gz",
                "UniqueId": "9d091111111111111111111111111111"
            },
            {
                "Dimensions": "{\"unInstanceId\":\"ins-19031111\"}",
                "IsShielded": 0,
                "Region": "gz",
                "UniqueId": "ba8a1111111111111111111111111111"
            },
            {
                "Dimensions": "{\"unInstanceId\":\"ins-19b01111\"}",
                "IsShielded": 0,
                "Region": "gz",
                "UniqueId": "1a301111111111111111111111111111"
            }
        ],
        "NoShieldedSum": 3,
        "InstanceGroup": null,
        "RequestId": "11111111-1111-1111-1111-111111111111",
        "Total": 3
    }
}

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
AuthFailure.UnauthorizedOperation	The request is not authorized. For more information on the authentication, see the CAM documentation.
DryRunOperation	DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation	Operation failed.
FailedOperation.AlertFilterRuleDeleteFailed	Failed to delete the filter rule.
FailedOperation.AlertPolicyCreateFailed	Failed to create the alarm policy.
FailedOperation.AlertPolicyDeleteFailed	Failed to delete the alarm policy.
FailedOperation.AlertPolicyDescribeFailed	Failed to query the alarm policy.
FailedOperation.AlertPolicyModifyFailed	Failed to modify the alarm policy.
FailedOperation.AlertTriggerRuleDeleteFailed	Failed to delete the trigger condition.
FailedOperation.DbQueryFailed	Failed to query the database.
FailedOperation.DbRecordCreateFailed	Failed to create the database record.
FailedOperation.DbRecordDeleteFailed	Failed to delete the database record.
FailedOperation.DbRecordUpdateFailed	Failed to update the database record.
FailedOperation.DbTransactionBeginFailed	Failed to start the database transaction.
FailedOperation.DbTransactionCommitFailed	Failed to submit the database transaction.
FailedOperation.DimQueryRequestFailed	Failed to query the service in the request dimension.
FailedOperation.DivisionByZero	The dividend is zero.
FailedOperation.DoHTTPTransferFailed	Backend service timed out.
FailedOperation.DruidQueryFailed	Failed to query analysis data.
FailedOperation.DruidTableNotFound	The druid table does not exist.
FailedOperation.DuplicateName	The name already exists.
FailedOperation.ServiceNotEnabled	The service is not enabled and can be used only after being enabled.
InternalError	Internal error.
InternalError.ExeTimeout	Execution timed out.
InvalidParameter	Invalid parameter.
InvalidParameter.InvalidParameter	Invalid parameter.
InvalidParameter.InvalidParameterParam	Invalid parameter.
InvalidParameterValue	The parameter value is incorrect.
LimitExceeded	Quota limit is reached.
LimitExceeded.MetricQuotaExceeded	Quota limit on metrics is reached. Requests containing unregistered metrics are prohibited.
MissingParameter	Missing parameter.
ResourceInUse	The resource is in use.
ResourceInsufficient	Insufficient resources.
ResourceNotFound	The resource is not found.
ResourceUnavailable	The resource is unavailable.
ResourcesSoldOut	The resources have been sold out.
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter.
UnsupportedOperation	Unsupported operation.

tencent cloud

Recent Pages

DescribeBindingPolicyObjectList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Getting the list of bound objects

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeBindingPolicyObjectList

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Getting the list of bound objects

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?