ListOperationTickets - 获取需要审批的运维申请列表

获取需要审批的运维申请列表。

接口说明

本接口用于管理员获取需要审批的运维申请列表。

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

调试

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

授权信息

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

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

请求参数

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

堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-st220aw****
RegionIdstring

堡垒机的地域 ID。

说明 地域 ID 和地域名称的对应关系,请参见地域和可用区
cn-hangzhou
PageNumberstring

指定分页查询时,当前页的页码。默认值为 1

1
PageSizestring

指定分页查询时,每页显示的数据最大条数。
PageSize 参数最大取值为 1000。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
AssetAddressstring

精确搜索待审批的运维资产地址。

10.167.XX.XX

返回参数

名称类型描述示例值
object

响应数据。

OperationTicketsarray<object>

待审批的运维申请列表。

itemobject

响应数据。

ApplyUserIdstring

运维申请人 ID。

1
ApplyUsernamestring

运维申请人用户名。

test
AssetAccountIdstring

申请运维的资产账户 ID。

1
AssetAccountNamestring

申请运维的资产账户登录名。

root
AssetAddressstring

申请运维的资产地址。

10.167.XX.XX
AssetIdstring

申请运维的资产 ID。

2
AssetNamestring

申请运维的资产名称。

poros-test
AssetNetworkDomainIdstring

申请运维的资产所属的网络域 ID。

2
AssetOsstring

申请运维的资产操作系统类型。

Linux
AssetSourcestring

申请运维的资产所属资产源的名称。取值:

  • Local:本地主机
  • Ecs:ECS 实例
  • Rds:RDS 实例
  • 第三方资产源名称
Local
AssetSourceInstanceIdstring

申请运维的资产所属资产源的 ID。

1
CreatedTimelong

提交申请的时间(秒,时间戳格式)。

1669965908
OperationTicketIdstring

需要审批的运维申请单的 ID。

1
ProtocolNamestring

申请运维的协议名称。

SSH
Statestring

审批状态。取值:

  • Normal:待审批
Normal
ApproveCommentstring

运维人员申请运维时填写的备注。

申请运维
EffectStartTimeinteger

运维人员申请的可以运维的开始时间。(秒,时间戳格式)

1685600242
EffectEndTimeinteger

运维人员申请的可以运维的结束时间。(秒,时间戳格式)

1679393152
EffectCountinteger

运维人员申请的登录的次数限制。取值:

  • 0:不限制登录次数,运维员在有效期内可以无限次数登录。
  • 1:运维员在有效期内只允许登录一次。
0
RequestIdstring

阿里云为该请求生成的唯一标识符。

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCountlong

待审批的运维申请单总数。

20

示例

正常返回示例

JSON格式

{
  "OperationTickets": [
    {
      "ApplyUserId": "1",
      "ApplyUsername": "test",
      "AssetAccountId": "1",
      "AssetAccountName": "root",
      "AssetAddress": "10.167.XX.XX",
      "AssetId": "2",
      "AssetName": "poros-test",
      "AssetNetworkDomainId": "2",
      "AssetOs": "Linux",
      "AssetSource": "Local",
      "AssetSourceInstanceId": "1",
      "CreatedTime": 1669965908,
      "OperationTicketId": "1",
      "ProtocolName": "SSH",
      "State": "Normal",
      "ApproveComment": "申请运维",
      "EffectStartTime": 1685600242,
      "EffectEndTime": 1679393152,
      "EffectCount": 0
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 20
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

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

变更历史

变更时间变更内容概要操作
2024-11-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情