通過此接口查詢資源。
接口說明
用戶可前往在線調試 API 門戶查看資源文檔和體驗 Cloud Control API。
此 API 包括資源的 Get 和 List 功能,根據不同的請求路徑,用戶可分別調用資源 List 和 Get 能力。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cloudcontrol:GetResources | get |
|
| 無 |
請求語法
GET /api/v1/providers/{provider}/products/{product}/resources/* HTTP/1.1
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
requestPath | string | 是 | 請求路徑。根據不同的請求路徑,用戶可分別調用資源 List 和資源 Get。 1.List: /api/v1/providers/{provider}/products/{product}/resources/{resourceType} 2.Get: /api/v1/providers/{provider}/products/{product}/resources/{resourceType}/{resourceId} 請求路徑中變量說明: provider: 云廠商,目前只支持 Aliyun。 product: 產品 Code。 resourceType: 資源類型。有父資源時,格式為{父資源類型 code}/父資源 ID/{資源類型 code}。 resourceId: 資源 ID。 | List(無父資源): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance List(有父資源): /api/v1/providers/aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account Get(無父資源): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo**** Get(有父資源): /api/v1/providers/Aliyun/products/Redis/resources/DBInstance/r-2ze8v41uei31lo****/Account/user**** |
regionId | string | 否 | 地域 ID。若云產品是 region 化產品,則此參數為必填。 | cn-beijing |
filter | object | 否 | 過濾條件。json 格式,可以將部分資源屬性作為過濾條件。 | |
nextToken | string | 否 | 用來標記當前開始讀取的位置,置空表示從頭開始。 | AAAAAdDWBF2**** |
maxResults | integer | 否 | 分頁查詢時每頁行數,最大不能超過 100。 | 10 |
返回參數
示例
正常返回示例
JSON
格式
{
"maxResults": 10,
"nextToken": "AAAAAdDWBF2****",
"requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"resource": {
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-8vbf5abe31c9c4d4",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
},
"resources": [
{
"resourceAttributes": {
"Status": "Available",
"Description": "",
"AccountPrivilege": "RoleReadWrite",
"InstanceId": "r-8vbf5abe31c9c4d4",
"RegionId": "cn-zhangjiakou",
"AccountType": "Normal",
"TypeInfo": {},
"AccountName": "cctest"
},
"resourceId": "cctest"
}
],
"totalCount": 20
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|