All Products
Search
Document Center

Cloud Firewall:DescribeInstanceMembers

Last Updated:Mar 19, 2024

Queries the information about members in Cloud Firewall.

Operation description

You can use this operation to query the information about members in Cloud Firewall.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:DescribeInstanceMembersRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPagestringNo

The page number. Default value: 1.

1
PageSizestringNo

The number of entries per page.

Default value: 20.

20
MemberUidstringNo

The UID of the member.

258039427902****
MemberDisplayNamestringNo

The name of the member.

cloudfirewall_2
MemberDescstringNo

The remarks of the member. The remarks must be 1 to 256 characters in length.

renewal

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

A531AE1A-FBA2-48B6-BAB8-84D02BD409EE
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of the members.

20
Membersobject []

The information about the member.

MemberDescstring

The remarks of the member.

renewal
MemberDisplayNamestring

The name of the member.

cloudfirewall_2
CreateTimeinteger

The time when the member was added to Cloud Firewall. The value is a timestamp. Unit: seconds.

1615189819
MemberUidlong

The UID of the member.

258039427902****
MemberStatusstring

The status of the member. Valid values:

  • normal
  • deleting
normal
ModifyTimeinteger

The time when the member was last modified. The value is a timestamp. Unit: seconds.

1615189819

Examples

Sample success responses

JSONformat

{
  "RequestId": "A531AE1A-FBA2-48B6-BAB8-84D02BD409EE",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 20
  },
  "Members": [
    {
      "MemberDesc": "renewal",
      "MemberDisplayName": "cloudfirewall_2",
      "CreateTime": 1615189819,
      "MemberUid": 0,
      "MemberStatus": "normal",
      "ModifyTime": 1615189819
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400ErrorParametersA parameter error occurred.A parameter error occurred.
400ErrorDBSelectAn error occurred while querying database.An error occurred while querying database.
400ErrorParamsNotEnoughParameters are insufficient.Parameters are insufficient.

For a list of error codes, visit the Service error codes.