搜索資源目錄管理賬號和多個成員中的資源。
接口說明
- 僅能搜索支持資源中心的云服務及資源類型。
- 如果您使用的是 RAM 用戶賬號或者 RAM 角色,需要被授予 SearchMultiAccountResources 接口的權限才能執行跨賬號資源搜索操作。更多信息,請參見 RAM 用戶使用資源中心。
- SearchMultiAccountResources 接口默認最多返回 20 條數據,您可以通過指定
MaxResults
參數調整最大返回條目數。 - 如果返回結果中不存在
NextToken
,則表示沒有更多數據。否則,則表示還有更多數據。如果想要查詢后續頁,需要將 SearchMultiAccountResources 接口的NextToken
參數設置為上一次返回結果中獲取到的NextToken
。如果未輸入NextToken
參數,查詢時默認返回第一頁的數據。 - 通過設置一個或多個過濾條件,可以精確資源的搜索范圍。支持的過濾參數以及匹配方式見下文。多個過濾條件之間是邏輯與
AND
的關系,只有同時滿足所有過濾條件的資源才會被返回。每個過濾條件內部是邏輯或OR
的關系,只要滿足任意一個過濾條件值的資源都會被返回。 - 您可以在示例中心 獲取更多查詢示例。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
resourcecenter:SearchMultiAccountResources |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Scope | string | 是 | 搜索的賬號范圍。取值:
| rd-r4**** |
NextToken | string | 否 | 查詢返回結果下一頁的令牌。 當返回結果數據總條數超過 | eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd**** |
MaxResults | integer | 否 | 每頁的最大數據條數。 取值范圍:1~100。 默認值:20。 | 10 |
Filter | array<object> | 否 | 過濾條件。 | |
object | 否 | 過濾條件。 | ||
Key | string | 否 | 過濾條件鍵。取值見下方 | ResourceGroupId |
MatchType | string | 否 | 匹配方式。 取值為 Equals,表示相等匹配。 | Equals |
Value | array | 否 | 過濾條件值。 | |
string | 否 | 過濾條件值。 | rg-aekzmrjn4ns**** | |
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
格式
{
"Filters": [
{
"Key": "RegionId",
"MatchType": "Equals",
"Values": [
"cn-hangzhou"
]
}
],
"MaxResults": 10,
"NextToken": "查詢返回結果下一頁的令牌。",
"RequestId": "EFA806B9-7F36-55AB-8B7A-D680C2C5EE57",
"Resources": [
{
"AccountId": "151266687691****",
"CreateTime": "2021-06-30T09:20:08Z",
"ExpireTime": "2023-06-14T14:35:45Z",
"IpAddressAttributes": [
{
"IpAddress": "192.168.1.2",
"NetworkType": "Public",
"Version": "Ipv4"
}
],
"IpAddresses": [
"192.168.1.2"
],
"RegionId": "cn-hangzhou",
"ResourceGroupId": "rg-acfmzawhxxc****\t\n",
"ResourceId": "vtb-bp11lbh452fr8940s****",
"ResourceName": "group1",
"ResourceType": "ACS::VPC::RouteTable",
"Tags": [
{
"Key": "test_key",
"Value": "test_value"
}
],
"ZoneId": "cn-hangzhou-k"
}
],
"Scope": "rd-r4****\n"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | NoPermission | You are not authorized to perform this operation. | 無操作權限。 |
400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 參數 MaxResults 不合法。 |
400 | MultiAccountServiceNotEnabled | Multi account ResourceCenter service is not enabled. | 多賬號資源中心服務未開通。 |
403 | NoPermission.AccountScope | The operator is not permitted for this account scope. | 當前用戶未授權操作此資源目錄賬號范圍。 |
404 | NotExists.Resource | The specified resource does not exist. | 指定資源不存在。 |
404 | NotExists.ResourceDirectory | The resource directory for the account is not enabled. | 當前賬號未開通資源目錄。 |
404 | NotExists.ResourceDirectory.FolderId | The specified folder does not exist. | 指定文件夾不存在。 |
409 | InvalidParameter.Scope | The Scope is invalid. | 參數Scope無效。 |
409 | NoPermission.ResourceDirectory.MemberAccount | ResourceDirectory Member Account is not authorized to perform this operation. | 資源目錄成員賬號不能執行此操作,請使用管理賬號操作。 |
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 數量超出上限。 |
409 | ServiceNotEnabled.SpecifiedAccount | ResourceCenter service of the specified account is not enabled. | 指定賬戶的資源中心服務未開通。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-11-21 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-11-10 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-05-05 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-07 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |