搜索當前賬號下有權限訪問的資源。
接口說明
- 僅能搜索當前賬號下有權限訪問的資源。
- 僅能搜索支持資源中心的云服務及資源類型。
- SearchResources 接口默認最多返回 20 條數據,您可以通過指定
MaxResults
參數調整最大返回條目數。 - 如果返回結果中不存在
NextToken
,則表示沒有更多數據。否則,則表示還有更多數據。如果想要查詢后續頁,需要將 SearchResources 接口的NextToken
參數設置為上一次返回結果中獲取到的NextToken
。如果未輸入NextToken
參數,查詢時默認返回第一頁的數據。 - 通過設置一個或多個過濾條件,可以精確資源的搜索范圍。支持的過濾參數以及匹配方式見下文。多個過濾條件之間是邏輯與
AND
的關系,只有同時滿足所有過濾條件的資源才會被返回。每個過濾條件內部是邏輯或OR
的關系,只要滿足任意一個過濾條件值的資源都會被返回。 - 您可以在示例中心獲取更多查詢示例。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
resourcecenter:SearchResources | list | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
NextToken | string | 否 | 查詢返回結果下一頁的令牌。 當返回結果數據總條數超過 | eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd**** |
MaxResults | integer | 否 | 每頁的最大數據條數。 取值范圍:1~500。 默認值:20。 | 10 |
Filter | array<object> | 否 | 過濾條件。 | |
object | 否 | 過濾條件。 | ||
Key | string | 否 | 過濾條件鍵。取值見下方 | RegionId |
Value | array | 否 | 過濾條件值。 | |
string | 否 | 過濾條件值。 | 過濾條件值。 | |
MatchType | string | 否 | 匹配方式。 取值:
| Equals |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmzawhxxc**** |
SortCriterion | object | 否 | 排序參數。 | |
Key | string | 否 | 排序條件。 取值:CreateTime,表示按資源創建時間排序。 | CreateTime |
Order | string | 否 | 排序順序。取值:
| ASC |
支持的過濾參數
參數 | 描述 | 支持的匹配類型 |
---|---|---|
ResourceType | 資源類型。 | Equals |
RegionId | 地域 ID。 | Equals |
ResourceId | 資源 ID。 | Equals、Prefix |
ResourceGroupId | 資源組 ID。 | Equals、Exists、NotExists |
ResourceName | 資源名稱。 | Equals、Contains |
Tag | 標簽鍵值對。 JSON 格式為 { "key": $key, "value": $value } ,key 與 value 至少出現一個。例如:查詢標簽鍵foo 和標簽值bar ,則傳遞{ "key": "foo", "value": "bar" } ;查詢標簽鍵foo ,則傳遞{ "key": "foo" } 。 | Contains、NotContains、NotExists |
VpcId | VPC ID。 | Equals |
VSwitchId | 交換機 ID。 | Equals |
返回參數
示例
正常返回示例
JSON
格式
{
"NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****\t\n",
"RequestId": "D696E6EF-3A6D-5770-801E-4982081FE4D0",
"MaxResults": 10,
"Filters": [
{
"Key": "RegionId",
"MatchType": "Equals",
"Values": [
"cn-hangzhou"
]
}
],
"Resources": [
{
"ResourceType": "ACS::VPC::RouteTable",
"CreateTime": "2021-06-30T09:20:08Z",
"ResourceGroupId": "rg-acfmzawhxxc****",
"ZoneId": "cn-hangzhou-k",
"AccountId": "151266687691****",
"ResourceId": "vtb-bp11lbh452fr8940s****",
"ResourceName": "group1",
"RegionId": "cn-hangzhou",
"Tags": [
{
"Key": "test_key",
"Value": "test_value"
}
],
"IpAddresses": [
"192.168.1.2"
],
"IpAddressAttributes": [
{
"IpAddress": "192.168.1.2",
"NetworkType": "Public",
"Version": "Ipv4"
}
],
"ExpireTime": "2021-07-30T09:20:08Z"
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | NoPermission | You are not authorized to perform this operation. | 無操作權限。 |
400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 參數 MaxResults 不合法。 |
409 | InvalidParameter.SortCriterion.Key | The specified parameter SortCriterion.Key is not valid. | 參數 SortCriterion.Key 不合法。 |
409 | ExceedLimit.Filter | The maximum length of Filters is exceeded. | 參數 Filter 數量超出上限。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-11-21 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-11-10 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-08-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-07 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |