DescribeResources - 查询资源列表

查询资源列表。

调试

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

授权信息

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

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

请求语法

GET /api/v1/resources HTTP/1.1

请求参数

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

资源类型

ACS::ECS::Instance
ResourceIdstring

资源 ID。例如,当待查询的资源为实例时,可以理解为 InstanceId。

i-0003***110
FailedRuleTemplatestring

评分失败的规则过滤

rule-000c***yc9
NextTokenstring

分页游标,如果有下一页,则该字段有返回值。说明 该参数只要返回数据,则说明还有下一页。您可以将返回的 NextToken 作为请求参数再次获得下一页的数据,直到返回为 Null,表示获取到了所有的数据。

cae**********699
MaxResultsinteger

分页查询时每页行数。最大值为 100。默认值:当不设置值或设置的值小于 10 时,默认值为 10。当设置的值大于 100 时,默认值为 100。

10
SortBystring

排序方式

protectionScore
SortOrderstring

ASC: 升序, DESC: 降序

ASC

返回参数

名称类型描述示例值
object

BaseResponse<ListResult>

Dataobject

返回数据

Contentarray<object>

本次请求所返回的记录集合

Contentobject
ResourceArnstring

资源 ARN(全局唯一)

acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx
ProductTypestring

云产品类型

ecs
ResourceTypestring

资源类型

ACS::ECS::Instance
ResourceIdstring

资源唯一标识

i-xxxxxxxx
ResourceNamestring

资源名称

test server
RegionIdstring

地域

cn-hangzhou
ZoneIdstring

可用区

cn-hangzhou-i
VpcIdstring

vpc ID

vpc-xxxxxxxx
VSwitchIdstring

vSwitch ID

vsw-xxxxxxxx
CreateTimelong

资源的创建时间

1697798340
Statusstring

资源状态

Running
TotalDataSizelong

数据量

0
StandardDataSizelong

标准类型数据量

0
IaDataSizelong

低频类型数据量

0
ArchiveDataSizelong

归档类型数据量

0
ColdArchiveDataSizelong

冷归档类型数据量

0
EnableCheckboolean

是否开启数据保护评分评估

0
ProtectionScoreinteger

资源保护评分

0
ProtectionScoreUpdatedTimelong

评分时间

0
RiskCountlong

有风险的检查项目数

0
CheckFailedCountlong

失败的检查项个数

0
NextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕

fb836242f4225fa0f0e0257362dfc6dd
MaxResultsinteger

本次请求所返回的最大记录条数

100
TotalCountlong

本次请求条件下的数据总量,此参数为可选参数,默认可不返回

149
RequestIdstring

请求的唯一标识

700683DE-0154-56D4-8D76-3B7A2C2C7DF9

示例

正常返回示例

JSON格式

{
  "Data": {
    "Content": [
      {
        "ResourceArn": "acs:ecs:cn-hangzhou:xxxxxxxx:instance/xxxxx\n",
        "ProductType": "ecs",
        "ResourceType": "ACS::ECS::Instance\n",
        "ResourceId": "i-xxxxxxxx\n",
        "ResourceName": "test server",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-i",
        "VpcId": "vpc-xxxxxxxx",
        "VSwitchId": "vsw-xxxxxxxx",
        "CreateTime": 1697798340,
        "Status": "Running",
        "TotalDataSize": 0,
        "StandardDataSize": 0,
        "IaDataSize": 0,
        "ArchiveDataSize": 0,
        "ColdArchiveDataSize": 0,
        "EnableCheck": true,
        "ProtectionScore": 0,
        "ProtectionScoreUpdatedTime": 0,
        "RiskCount": 0,
        "CheckFailedCount": 0
      }
    ],
    "NextToken": "fb836242f4225fa0f0e0257362dfc6dd",
    "MaxResults": 100,
    "TotalCount": 149
  },
  "RequestId": "700683DE-0154-56D4-8D76-3B7A2C2C7DF9"
}

错误码

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