查詢資源列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
bdrc:DescribeResources | none | *全部資源 * |
| 無 |
請求語法
GET /api/v1/resources HTTP/1.1
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceType | string | 否 | 資源類型 | ACS::ECS::Instance |
ResourceId | string | 否 | 資源 ID。例如,當待查詢的資源為實例時,可以理解為 InstanceId。 | i-0003***110 |
FailedRuleTemplate | string | 否 | 評分失敗的規則過濾 | rule-000c***yc9 |
NextToken | string | 否 | 分頁游標,如果有下一頁,則該字段有返回值。說明 該參數只要返回數據,則說明還有下一頁。您可以將返回的 NextToken 作為請求參數再次獲得下一頁的數據,直到返回為 Null,表示獲取到了所有的數據。 | cae**********699 |
MaxResults | integer | 否 | 分頁查詢時每頁行數。最大值為 100。默認值:當不設置值或設置的值小于 10 時,默認值為 10。當設置的值大于 100 時,默認值為 100。 | 10 |
SortBy | string | 否 | 排序方式 | protectionScore |
SortOrder | string | 否 | ASC: 升序, DESC: 降序 | ASC |
返回參數
示例
正常返回示例
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,
"StorageClass": "",
"DataRedundancyType": ""
}
],
"NextToken": "fb836242f4225fa0f0e0257362dfc6dd",
"MaxResults": 100,
"TotalCount": 149
},
"RequestId": "700683DE-0154-56D4-8D76-3B7A2C2C7DF9"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-22 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |