全部产品
Search
文档中心

云防火墙:DescribeInstanceMembers - 获取云防火墙成员账号信息

更新时间:Sep 02, 2024

获取云防火墙成员账号信息。

接口说明

本接口一般用于查询云防火墙成员账号信息。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cloudfirewall:DescribeInstanceMembersget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CurrentPagestring

分页查询时,返回第几页数据。 默认值为 1,表示返回第 1 页数据。

1
PageSizestring

分页查询时,每页包含多少条结果。

默认值为 20,表示每页包含 20 条结果。

20
MemberUidstring

云防火墙成员账号的 UID。

258039427902****
MemberDisplayNamestring

云防火墙成员账号的名称。

cloudfirewall_2
MemberDescstring

云防火墙成员账号的备注信息,长度为 1~256 个字符。

renewal

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

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

分页查询时的页面信息。

CurrentPageinteger

本次查询第几页数据。

1
PageSizeinteger

本次查询每页包含多少条结果。

20
TotalCountinteger

云防火墙成员账号的总数量。

20
Membersarray<object>

云防火墙成员账号的信息。

object
MemberDescstring

云防火墙成员账号的备注信息。

renewal
MemberDisplayNamestring

云防火墙成员账号的名称。

cloudfirewall_2
CreateTimeinteger

云防火墙成员账号的加入时间。使用时间戳格式,单位:秒。

1615189819
MemberUidlong

云防火墙成员账号的 UID。

258039427902****
MemberStatusstring

云防火墙成员账号的状态。取值:

  • normal:正常
  • deleting:删除中
normal
ModifyTimeinteger

云防火墙成员账号的最近修改时间。使用时间戳格式,单位:秒。

1615189819

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ErrorParametersA parameter error occurred.参数错误
400ErrorDBSelectAn error occurred while querying database.内部错误:数据库查询错误
400ErrorParamsNotEnoughParameters are insufficient.参数不足

访问错误中心查看更多错误码。