cisco.meraki.organizations_api_requests_info 模块 – 组织_apirequests的信息模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： cisco.meraki.organizations_api_requests_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有组织_apirequests。
列出组织发起的 API 请求。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
AdminId 查询参数。按发起 API 请求的管理员 ID 过滤结果。 |
|
方向 (字符串)，分页方向，为“next”（默认）或“prev”页 默认值： |
|
EndingBefore 查询参数。服务器用于指示页面结尾的令牌。通常是时间戳或 ID，但不限于这些。客户端应用程序不应定义此参数。HTTP Link 标头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
附加标头。 |
|
meraki_action_batch_retry_wait_time (整数)，操作批处理并发错误重试等待时间 默认值： |
|
meraki_api_key (字符串)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (字符串)，位于所有端点资源之前 默认值： |
|
meraki_be_geo_id (字符串)，用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： |
|
meraki_caller (字符串)，用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： |
|
meraki_certificate_path (字符串)，如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值： |
|
meraki_inherit_logging_config (布尔值)，继承您自己的日志记录实例 选项
|
|
meraki_log_file_prefix (字符串)，日志文件名后附加日期和时间戳 默认值： |
|
log_path (字符串)，输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值： |
|
meraki_maximum_retries (整数)，遇到 429 或其他服务器端错误时最多重试这么多次 默认值： |
|
meraki_nginx_429_retry_wait_time (整数)，Nginx 429 重试等待时间 默认值： |
|
meraki_output_log (布尔值)，创建输出日志文件？ 选项
|
|
meraki_print_console (布尔值)，将日志输出打印到控制台？ 选项
|
|
meraki_requests_proxy (字符串)，如果需要，用于 HTTPS 的代理服务器和端口 默认值： |
|
meraki_retry_4xx_error (布尔值)，如果遇到其他 4XX 错误（除了 429）则重试？ 选项
|
|
meraki_retry_4xx_error_wait_time (整数)，其他 4XX 错误重试等待时间 默认值： |
|
meraki_simulate (布尔值)，模拟 POST/PUT/DELETE 调用以防止更改？ 选项
|
|
meraki_single_request_timeout (整数)，每个 API 调用的最大秒数 默认值： |
|
meraki_suppress_logging (布尔值)，禁用所有日志记录？那么您就只能靠自己了！ 选项
|
|
meraki_use_iterator_for_get_pages (布尔值)，list* 方法将返回包含每个对象的迭代器，而不是包含所有项目的完整列表 选项
|
|
meraki_wait_on_rate_limit (布尔值)，如果遇到 429 速率限制错误则重试？ 选项
|
|
方法查询参数。按 API 请求的方法过滤结果（必须为“GET”、“PUT”、“POST”或“DELETE”）。 |
|
OperationIds 查询参数。按 API 请求的一个或多个操作 ID 过滤结果。 |
|
OrganizationId 路径参数。组织ID。 |
|
Path 查询参数。根据 API 请求的路径过滤结果。 |
|
PerPage 查询参数。每页返回的条目数量。可接受范围为 3-1000。默认为 50。 |
|
ResponseCode 查询参数。根据 API 请求的响应代码过滤结果。 |
|
SourceIp 查询参数。根据发起 API 请求的 IP 地址过滤结果。 |
|
StartingAfter 查询参数。服务器用来指示页面起始位置的令牌。通常是时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
T0 查询参数。数据的起始时间范围。最大回溯期为今天起 31 天。 |
|
T1 查询参数。数据的结束时间范围。T1 最多可以比 t0 晚 31 天。 |
|
Timespan 查询参数。获取信息的时段。如果指定 timespan，则不要指定参数 t0 和 t1。该值必须以秒为单位，并且小于或等于 31 天。默认为 31 天。 |
|
total_pages(int)，与 perPage 一起使用以获取总结果，最多为 total_pages*perPage；-1 表示所有页面。 |
|
UserAgent 查询参数。根据 API 请求的用户代理字符串过滤结果。 |
|
Version 查询参数。根据 API 请求的 API 版本过滤结果。 |
注释
注意
使用的 SDK 方法为 organizations.Organizations.get_organization_api_requests，
使用的路径为 get /organizations/{organizationId}/apiRequests，
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco Meraki SDK 的嵌入式连接管理器。
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接。
另请参见
另请参见
- Cisco Meraki 文档，了解 organizations getOrganizationApiRequests
getOrganizationApiRequests API 的完整参考。
示例
- name: Get all organizations _apirequests
cisco.meraki.organizations_api_requests_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
t0: string
t1: string
timespan: 0
perPage: 0
startingAfter: string
endingBefore: string
adminId: string
path: string
method: string
responseCode: 0
sourceIp: string
userAgent: string
version: 0
operationIds: []
organizationId: string
total_pages: -1
direction: next
register: result
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表。 返回：始终 示例： |