ARM サーバーおよび AIC インスタンスの情報を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ens:DescribeARMServerInstances |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ServerIds |
array |
任意 |
ARM サーバーの ID。 |
|
|
string |
任意 |
ARM サーバーの ID。 |
cas-instance**** |
|
| EnsRegionIds |
array |
任意 |
Edge Node Service (ENS) ノードの ID。 |
|
|
string |
任意 |
ENS ノードの ID。 |
cn-chengdu-telecom-4 |
|
| PageNumber |
integer |
任意 |
ページ番号。先頭ページは 1 です。 デフォルト値:1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりに返されるエントリ数。最大値: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 |
| Tags |
array<object> |
任意 |
タグ一覧。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
タグキー。 |
key-1 |
| Value |
string |
任意 |
タグ値。 |
value-1 |
| OrderByParams |
string |
任意 |
結果の並べ替え順序。有効な値:ServerIdSort、ServerNameSort、ExpireTimeSort、CreationTimeSort、EnsRegionIdSort。 asc:昇順、desc:降順。 |
{"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc"} |
| DescribeAICInstances |
boolean |
任意 |
結果にコンテナ情報が含まれるかどうかを指定します。有効な値:
|
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。 |
4EC47282-1B74-4534-BD0E-403F3EE64CAF |
| Servers |
array<object> |
サーバーおよび AIC インスタンスに関する情報。 |
|
|
array<object> |
|||
| CreationTime |
string |
インスタンスの作成日時。 |
2022-05-07 11:59:09 |
| ExpiredTime |
string |
インスタンスの有効期限切れ日時。 |
2027-05-07 11:59:09 |
| AICInstances |
array<object> |
AIC インスタンスに関する情報。 |
|
|
array<object> |
|||
| Frequency |
integer |
AIC インスタンスの更新頻度。単位:Hz。 |
120 |
| ImageId |
string |
AIC イメージの ID。 |
m-**** |
| InstanceId |
string |
AIC インスタンスの ID。 |
aic-instance**** |
| NetworkAttributes |
object |
AIC インスタンスのネットワーク属性。 |
|
| IpAddress |
string |
AIC インスタンスの IP アドレス。 |
192.168.XX.XX |
| NetworkId |
string |
AIC インスタンスのネットワーク ID。 |
n-***** |
| VSwitchId |
string |
AIC インスタンスの vSwitch ID。 |
vsw-**** |
| SdgDeployInfo |
object |
AIC インスタンスにデプロイされた共有データグループ (SDG) の情報。 |
|
| SDGId |
string |
SDG の ID。 |
sdg-xxxxx |
| Status |
string |
SDG のデプロイメントステータス。有効な値:
|
success |
| Resolution |
string |
AIC インスタンスの解像度。 |
1920*1080 |
| Spec |
string |
AIC インスタンスの仕様。 |
aic.cf53r.c2.np |
| State |
string |
AIC インスタンスの操作ステータス。有効な値:
|
success |
| Status |
string |
AIC インスタンスの実行ステータス。有効な値:
|
running |
| Name |
string |
コンテナの名前。 |
AIC-Name |
| LatestAction |
string |
直近で実行された操作。 |
ServerCreate |
| EnsRegionId |
string |
ENS ノードの ID。 |
cn-hanghzou-27 |
| ServerId |
string |
サーバーの ID。 |
cas-****** |
| SpecName |
string |
サーバー仕様。 |
cas.cf53r |
| State |
string |
サーバーの操作ステータス。有効な値:
|
success |
| Status |
string |
サーバーの実行ステータス。有効な値:
|
running |
| Namespace |
string |
サーバーが属するクラスターの名前空間。 |
default |
| Name |
string |
サーバーの名前。 |
Server-Name |
| PayType |
string |
課金方法。 |
prepay |
| LatestAction |
string |
直近で実行された操作。 |
ServerCreate |
| Tags |
array<object> |
タグコレクション。 |
|
|
object |
タグ。 |
||
| Key |
string |
タグキー。 |
key-1 |
| Value |
string |
タグ値。 |
value-1 |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| TotalCount |
integer |
返されたエントリの合計数。 |
2 |
例
成功レスポンス
JSONJSON
{
"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",
"Tags": [
{
"Key": "key-1",
"Value": "value-1"
}
]
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Parameter.Invalid | This service has not been activated. | |
| 400 | Interface.Call.Error | The interface call error | |
| 400 | Interface.Call.Failed | %s. | |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。