アプリケーションの一覧を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sae:ListApplications |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /pop/v1/sam/app/listApplications HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| CurrentPage |
integer |
任意 |
現在のページ番号。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリにおける 1 ページあたりのエントリ数。有効な値: [0,10000]。 |
20 |
| AppName |
string |
任意 |
アプリケーション名。 |
demo-app |
| NamespaceId |
string |
任意 |
名前空間の ID。 |
cn-beijing:demo |
| Tags |
string |
任意 |
タグのキーと値のペア。有効な値:
タグは大文字と小文字が区別されます。複数のタグを指定した場合、指定されたすべてのタグが作成され、リソースに付加されます。同じリソース上の各タグキーには、タグ値を 1 つだけ設定できます。既存のタグキーを追加した場合、対応するタグ値は新しい値に更新されます。 タグは |
[{"key":"key","value":"value"}] |
| OrderBy |
string |
任意 |
アプリケーションをソートするフィールド。有効な値:
|
runnings |
| Reverse |
boolean |
任意 |
アプリケーションインスタンスを実行ステータス順にソートするかどうかを指定します。インスタンスのステータスが同じ場合は、インスタンス ID でソートされます。有効な値:
インスタンスの昇順は以下の通りです:
|
true |
| FieldType |
string |
任意 |
アプリケーションをフィルターするディメンション。有効な値:
|
appName |
| FieldValue |
string |
任意 |
対象アプリケーションのアプリケーション名、アプリケーション ID、SLB IP アドレス、またはインスタンス IP アドレス。 |
demo-app |
| AppSource |
string |
任意 |
Serverless App Engine (SAE) のアプリケーションタイプ。
|
micro_service |
| IsStateful |
string |
任意 |
アプリケーションがステートフルかどうかを指定します。 |
|
| NewSaeVersion |
string |
任意 |
アプリケーションのバージョン。有効な値:
|
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答データ。 |
||
| Message |
string |
呼び出し結果に関する追加情報。 |
success |
| RequestId |
string |
リクエスト ID。 |
B4D805CA-926D-41B1-8E63-7AD0C1ED**** |
| Data |
object |
アプリケーション一覧。 |
|
| CurrentPage |
integer |
現在のページ番号。 |
1 |
| TotalSize |
integer |
アプリケーションの総数。 |
2 |
| PageSize |
integer |
ページサイズ。 |
20 |
| Applications |
array<object> |
アプリケーション一覧。 |
|
|
array<object> |
アプリケーション一覧の情報。 |
||
| AppName |
string |
アプリケーション名。 |
demo-app |
| NamespaceId |
string |
名前空間の ID。 |
cn-beijing:demo |
| AppDeletingStatus |
boolean |
アプリケーションが削除中かどうかを示します。有効値：
|
false |
| AppId |
string |
アプリケーションの ID。 |
f7730764-d88f-4b9a-8d8e-cd8efbfe**** |
| Tags |
array<object> |
アプリケーションに割り当てられたタグの配列。 |
|
|
object |
タグの詳細。 |
||
| Key |
string |
タグキー。 |
key |
| Value |
string |
タグ値。 |
value |
| RunningInstances |
integer |
実行中のインスタンス数。 |
2 |
| Instances |
integer |
設定されたアプリケーションインスタンス数。 |
2 |
| RegionId |
string |
アプリケーションがデプロイされているリージョンの ID。 |
cn-beijing |
| AppDescription |
string |
アプリケーションの説明。 |
description |
| Cpu |
integer |
各インスタンスに割り当てられた CPU。単位はミリコアです。この値を 0 にすることはできません。有効値：
|
1000 |
| Mem |
integer |
各インスタンスに割り当てられたメモリ。単位はメガバイト (MB) です。この値を 0 にすることはできず、CPU 割り当てと互換性がある必要があります。次のオプションが利用可能です：
|
1024 |
| MseEnabled |
boolean |
アプリケーションで Microservices Engine (MSE) が有効になっているかどうかを示します。 |
true |
| MseNamespaceId |
string |
MSE 名前空間の ID。この値によってサービスのエディションが決まります。
|
sae-ent |
| BaseAppId |
string |
ベースアプリケーションの ID。このパラメーターは、カナリアリリースアプリケーションの場合にのみ返されます。 |
xxx-xxx-xx-xxx |
| ProgrammingLanguage |
string |
アプリケーションのプログラミング言語。 |
java |
| Children |
array<object> |
このアプリケーションに関連付けられているカナリアリリースアプリケーションの配列。 |
|
|
array<object> |
カナリアリリースアプリケーションの詳細。 |
||
| AppName |
string |
カナリアリリースアプリケーションの名前。 |
app1 |
| NamespaceId |
string |
名前空間 ID。 |
cn-beijing:demo |
| AppDeletingStatus |
boolean |
カナリアリリースアプリケーションが削除中かどうかを示します。 |
false |
| AppId |
string |
カナリアリリースアプリケーションの ID。 |
xxx-xxx-xxx-xxx |
| ScaleRuleEnabled |
boolean |
自動スケーリングポリシーが有効になっているかどうかを示します。 |
false |
| ScaleRuleType |
string |
自動スケーリングポリシーのタイプ。 |
timing |
| Tags |
array<object> |
カナリアリリースアプリケーションに割り当てられたタグの配列。 |
|
|
object |
タグオブジェクトの詳細。 |
||
| Key |
string |
タグキー。 |
key |
| Value |
string |
タグ値。 |
value |
| RunningInstances |
integer |
実行中のインスタンス数。 |
2 |
| Instances |
integer |
カナリアリリースアプリケーションに設定されたインスタンス数。 |
2 |
| RegionId |
string |
リージョン ID。 |
cn-beijing |
| AppDescription |
string |
アプリケーションの説明。 |
Test application |
| Cpu |
integer |
CPU 仕様。 |
2000 |
| Mem |
integer |
メモリ仕様。 |
2048 |
| MseEnabled |
boolean |
アプリケーションで Microservices Engine (MSE) が有効になっているかどうかを示します。 |
true |
| BaseAppId |
string |
ベースアプリケーションの ID。 |
ee99cce6-1c8e-4bfa-96c3-3e2fa9****** |
| ProgrammingLanguage |
string |
アプリケーションのプログラミング言語。 |
java |
| AppType |
string |
アプリケーションのデプロイメントメソッド。 |
Image |
| NamespaceName |
string |
名前空間の名前。 |
demo |
| IsStateful |
boolean |
カナリアリリースアプリケーションがステートフルかどうかを示します。 |
|
| NewSaeVersion |
string |
アプリケーションのエディション：
|
pro |
| ResourceType |
string |
リソースタイプ。 |
|
| EnableIdle |
string |
アプリケーションがアイドル時に自動的に停止するように設定されているかどうかを示します。 |
|
| ImageUrl |
string |
コンテナイメージの URL。 |
registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0 |
| PackageUrl |
string |
アプリケーションのデプロイメントパッケージの URL。 |
https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar |
| AppType |
string |
アプリケーションのデプロイメントメソッド。 |
Image |
| NamespaceName |
string |
名前空間の名前。 |
demo |
| IsStateful |
boolean |
アプリケーションがステートフルかどうかを示します。 |
|
| NewSaeVersion |
string |
アプリケーションのエディション：
|
pro |
| EnableIdle |
string |
アプリケーションがアイドル時に自動的に停止するように設定されているかどうかを示します。 |
false |
| DiskSize |
integer |
ディスクサイズ (GB)。 |
20 |
| VpcId |
string |
VPC の ID。 |
|
| ResourceType |
string |
リソースタイプ。 |
|
| Labels |
object |
アプリケーションのラベル。 |
|
|
string |
|||
| RaspEnabled |
boolean |
||
| ErrorCode |
string |
エラーコード。有効な値:
|
|
| Code |
string |
API ステータスまたは POP エラーコード。有効な値:
|
200 |
| Success |
boolean |
アプリケーション一覧が取得されたかどうかを示します。有効な値:
|
true |
| CurrentPage |
integer |
現在のページ番号。 |
1 |
| TotalSize |
integer |
アプリケーションの総数。 |
2 |
| PageSize |
integer |
ページサイズ。 |
20 |
例
成功レスポンス
JSONJSON
{
"Message": "success",
"RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
"Data": {
"CurrentPage": 1,
"TotalSize": 2,
"PageSize": 20,
"Applications": [
{
"AppName": "demo-app",
"NamespaceId": "cn-beijing:demo",
"AppDeletingStatus": false,
"AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
"Tags": [
{
"Key": "key",
"Value": "value"
}
],
"RunningInstances": 2,
"Instances": 2,
"RegionId": "cn-beijing",
"AppDescription": "description",
"Cpu": 1000,
"Mem": 1024,
"MseEnabled": true,
"MseNamespaceId": "sae-ent",
"BaseAppId": "xxx-xxx-xx-xxx",
"ProgrammingLanguage": "java",
"Children": [
{
"AppName": "app1",
"NamespaceId": "cn-beijing:demo",
"AppDeletingStatus": false,
"AppId": "xxx-xxx-xxx-xxx",
"ScaleRuleEnabled": false,
"ScaleRuleType": "timing",
"Tags": [
{
"Key": "key",
"Value": "value"
}
],
"RunningInstances": 2,
"Instances": 2,
"RegionId": "cn-beijing",
"AppDescription": "Test application",
"Cpu": 2000,
"Mem": 2048,
"MseEnabled": true,
"BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
"ProgrammingLanguage": "java",
"AppType": "Image",
"NamespaceName": "demo",
"IsStateful": false,
"NewSaeVersion": "pro",
"ResourceType": "",
"EnableIdle": ""
}
],
"ImageUrl": "registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
"PackageUrl": "https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar",
"AppType": "Image",
"NamespaceName": "demo",
"IsStateful": false,
"NewSaeVersion": "pro",
"EnableIdle": "false",
"DiskSize": 20,
"VpcId": "",
"ResourceType": "",
"Labels": {
"key": ""
},
"RaspEnabled": false
}
]
},
"ErrorCode": "",
"Code": "200",
"Success": true,
"CurrentPage": 1,
"TotalSize": 2,
"PageSize": 20
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Illegal.argument | Illegal argument |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。