全部产品
Search

搜索本产品

    云安全中心：DescribeOfflineMachines - 获取离线服务器

    文档中心

    云安全中心：DescribeOfflineMachines - 获取离线服务器

    更新时间：Nov 25, 2024

    获取离线服务器信息。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    SourceIpstring否

    访问源的 IP 地址。

    		180.113.XX.XX
    PageSizeinteger否

    设置分页查询时，每页显示的备份文件的数量。默认值为 5，表示每页显示 5 条备份文件。

    		5
    CurrentPageinteger否

    设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。

    		4
    RegionNostring否

    服务器所在的地域。

    说明 您可以调用 DescribeCriteria 接口通过 Name 为 regionId 的项的 Values 来获取支持的地域。
    		cn-hangzhou
    Osstring否

    操作系统。

    说明 您可以调用 DescribeCriteria 接口通过 Name 为 osType 的项的 Values 来获取支持的操作系统。
    		linux
    Remarkstring否

    要查询的资产信息，可以设置为资产名称、公网 IP。

    		172.20.XX.XX
    Vendorinteger否

    服务器厂商。取值：

    • 0：阿里云资产
    • 1：云外资产
    • 2：IDC 资产
    • 3、4、5、7：其它云资产
    • 8：轻量级资产
    		0
    RegionIdStrstring否

    服务器所在的地域。

    说明 您可以调用 DescribeCriteria 接口通过 Name 为 regionId 的项的 Values 来获取支持的地域。
    		cn-hangzhou

    返回参数

    名称类型描述示例值
    object

    查询返回的数据信息。

    CurrentPageinteger

    分页查询时，显示的当前页的页码。

    		1
    RequestIdstring

    本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    		7E0618A9-D5EF-4220-9471-C42B5E92719F
    PageSizeinteger

    分页查询时，显示的每页数据的最大条数。

    		5
    TotalCountinteger

    数据的总条数。

    		44
    MachineListarray<object>

    服务器信息列表。

    Machineobject

    服务器信息。

    Uuidstring

    服务器 UUID。

    		6d5b361f-958d-48a8-a9d2-d6e82c1****
    MachineRegionstring

    服务器所在的地域。

    		cn-hangzhou
    InternetIpstring

    服务器外网 IP。

    		120.79.XX.XX
    VendorNamestring

    服务器的服务商名称。

    取值：

    • ALIYUN：阿里云
    • OUT：云外资产
    • IDC：IDC
    • TENCENT：其它云
    • HUAWEICLOUD：其它云
    • Microsoft：其它云
    • AWS：其它云
    • TRIPARTITE：轻量级服务器
    		ALIYUN
    InstanceNamestring

    服务器实例的名称。

    		sql-test-001
    Osstring

    服务器的操作系统。取值：

    • linux：linux

    • windows：windows

    • windows-2003：windows-2003

    		linux
    InstanceIdstring

    服务器实例的 ID。

    		sas-bdrvxb4b****
    IntranetIpstring

    服务器的私网 IP 地址。

    		192.168.XX.XX
    Vendorinteger

    服务器厂商。取值：

    • 0：阿里云资产
    • 1：云外资产
    • 2：IDC 资产
    • 3、4、5、7：其它云资产
    • 8：轻量级资产
    		0
    RegionIdstring

    服务器所在的地域的 ID。

    		cn-shanghai

    示例

    正常返回示例

    JSON格式

    {
  "CurrentPage": 1,
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "PageSize": 5,
  "TotalCount": 44,
  "MachineList": [
    {
      "Uuid": "6d5b361f-958d-48a8-a9d2-d6e82c1****",
      "MachineRegion": "cn-hangzhou",
      "InternetIp": "120.79.XX.XX",
      "VendorName": "ALIYUN",
      "InstanceName": "sql-test-001",
      "Os": "linux",
      "InstanceId": "sas-bdrvxb4b****",
      "IntranetIp": "192.168.XX.XX",
      "Vendor": 0,
      "RegionId": "cn-shanghai"
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    403NoPermissioncaller has no permission当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
    500ServerErrorServerError服务故障，请稍后重试！

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

    变更历史

    变更时间变更内容概要操作
    2022-12-23OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记查看变更详情