調用DescribeARMServerInstances獲取ARM服務器和AIC實例信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ens:DescribeARMServerInstances | list | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServerIds | array | 否 | 服務器實例 ID 列表。 | |
string | 否 | 服務器實例 ID 列表。 | cas-instance**** | |
EnsRegionIds | array | 否 | ENS 節點 ID 列表。 | |
string | 否 | ENS 節點 ID 列表。 | cn-chengdu-telecom-4 | |
PageNumber | integer | 否 | 查詢列表的頁碼。起始值為 1。 默認值:1。 | 1 |
PageSize | integer | 否 | 分頁查詢時設置的每頁行數,最大值為 100 行。 默認值:10。 | 10 |
MinDate | string | 否 | 查詢起始時間,格式"2006-01-02";默認無時間限制。 | 2006-01-02 |
MaxDate | string | 否 | 查詢終止時間,格式"2006-01-02";默認無時間限制。 | 2006-01-03 |
States | array | 否 | 操作狀態列表。 | |
string | 否 | 服務器操作狀態。
| success | |
AICSpecs | array | 否 | 容器規格列表。 | |
string | 否 | 容器規格。 | aic.cf53r.c2.np | |
ServerSpecs | array | 否 | 服務器規格列表。 | |
string | 否 | 服務器規格。 | cas.cf53r | |
Name | string | 否 | 服務器名稱。 | Server-Name |
Namespace | string | 否 | 命名空間。 | default |
OrderByParams | string | 否 | 查詢結果排序方式,可設置按照 ServerIdSort(服務器 ID)、ServerNameSort(服務器名稱)、ExpireTimeSort(到期時間)、CreationTimeSort(創建時間)、EnsRegionIdSort(節點 ID)中的一個或者多個結果排序。 取值含義:asc:升序, desc:降序。 | {"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc"} |
DescribeAICInstances | boolean | 否 | 查詢結果是否包含容器信息,取值:
| true |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"Servers": [
{
"CreationTime": "2022-05-07 11:59:09",
"ExpiredTime": "2027-05-07 11:59:09",
"AICInstances": [
{
"Frequency": 120,
"ImageId": "m-****",
"InstanceId": "aic-instance****",
"NetworkAttributes": {
"IpAddress": "192.168.XX.XX",
"NetworkId": "n-*****",
"VSwitchId": "vsw-****"
},
"SdgDeployInfo": {
"SDGId": "sdg-xxxxx",
"Status": "success"
},
"Resolution": "1920*1080",
"Spec": "aic.cf53r.c2.np",
"State": "success",
"Status": "running",
"Name": "AIC-Name",
"LatestAction": "ServerCreate"
}
],
"EnsRegionId": "cn-hanghzou-27",
"ServerId": "cas-******",
"SpecName": "cas.cf53r",
"State": "success",
"Status": "running",
"Namespace": "default",
"Name": "Server-Name",
"PayType": "prepay",
"LatestAction": "ServerCreate"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Parameter.Invalid | This service has not been activated. | 未開通該產品服務 |
400 | Interface.Call.Error | The interface call error | 接口調用出錯 |
400 | Parameter.Invalid | The parameter is invalid. Please check your parameters and try it again. | 參數不合法 |
400 | Interface.Call.Failed | %s. | 請求失敗 |
400 | NoPermission | Permission denied. | 沒有足夠的權限,請聯系云賬號管理員授予您相應權限。 |
400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-09-08 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-08-09 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-05-09 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-03-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-23 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |