Tenant Cloud Security Cloud Workload Protection Platform Advanced Defense APIs DescribeMaPodList

DescribeMaPodList

Last Updated At: 2026-08-02 00:04:56

1. Interface Description

Interface request domain name: cwp.api3.convergecloud.com.

This API is used to obtain the micro-alarm pod list.

Default interface request rate limit: 20 times per second.

Interface update time: 0001-01-01 00:00:00.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeMaPodList
Version Yes No String Public parameter, The value of this interface: 2018-02-28
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
By No No String Field for sorting. Valid values: [CreateTime]
Example: CreateTime
Filters No No Array of Filters
  • Name - string - Required: No - Pod name
  • Id - string - Required: No - Pod ID
  • Ip - string - Required: No - IP address
  • Status - string - Required: No - Pod status
  • ClusterId - string - Required: No - Cluster ID
  • ClusterName - string - Required: No - Cluster name
  • Label - string - Required: No - Associated tag
  • IsEnabled - string - Required: No - Monitoring status

    • Example:View
    Limit No No Int64 Maximum number of entries to return. Default value: 10. Maximum number: 100.
    Example: 10
    Offset No No Int64 Offset. Default value: 0.
    Example: 0
    Order No No String Sorting order. ASC: ascending order. DESC: descending order.
    Example: ASC

    3. Output Parameters

    Parameter name Type Description
    List Array of MaPod Pod List
    Example:View
    TotalCount Int64 Total number.
    Example: 10
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InternalError Internal error.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    InvalidParameter Invalid parameter.
    OperationDenied Operation denied.
    InvalidParameterValue The parameter value is invalid.