GetApplicationGroup API リファレンス - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

アプリケーショングループの詳細を取得します。アプリケーション管理サービスは中国 (杭州) リージョンでのみ利用可能です。杭州エンドポイントを使用してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:GetApplicationGroup

get

*ApplicationGroup。

acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}

oos:TLSVersion

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。cn-hangzhou のみがサポートされています。	cn-hangzhou
Name	string	必須	アプリケーショングループの名前。	MyApplicationGroup
ApplicationName	string	必須	アプリケーション名。	MyApplication
ShowMonitorURL	boolean	任意	アプリケーションモニタリング URL を返すかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object
ApplicationGroup	object	アプリケーショングループの詳細。
ApplicationName	string	アプリケーション名。	MyApplication
ApplicationSource	string	アプリケーションのソース。	{"Platform":"github","RepoName":"xxx/springboot-ecs-sourcecode-demo","Owner":"xxx","Branch":"main","CommitHash":"8559ff3xxxxxxxxxf06c6fe","CommitMessage":"ComputeNest プロジェクトのソースを初期化"}
CmsGroupId	string	CloudMonitor グループの ID。	12345678
CreateDate	string	アプリケーショングループが作成された時間。	2021-09-07T10:28:25Z
DeployOutputs	string	Deployment 結果の出力。	{ "出力": [ { "Description": "説明なし", "OutputKey": "InstanceIds" } ], "StackId": "6ef4b860-f6e7-4145-8d22-f4a2a32363e1" }
DeployParameters	string	アプリケーショングループの構成情報。	{ "テンプレートURL": "https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json", "Parameters": { "ZoneId": "cn-hangzhou-k", "ProjectName": "test", "SystemDiskSize": 40, "InstanceChargeType": "PostPaid", "SecurityGroupId": "sg-bp1a4374akk63jl8tddy", "VSwitchId": "vsw-bp1fcvc3zn0jrag86rrlm", "SystemDiskCategory": "cloud_essd", "InstancePassword": "******", "InternetChargeType": "PayByTraffic", "InstanceCount": 1, "InternetMaxBandwidthOut": 0, "VpcId": "vpc-bp1i99boyas8i8m9t3skp", "EcsImageId": "centos_8_5_x64_20G_alibase_20211228.vhd", "DataDiskSize": 100, "EcsInstanceType": "ecs.s6-c1m4.small", "DataDiskCategory": "cloud_efficiency", "EnvironmentCommandId": "c-hz028fc3g031gcg" } }
DeployRegionId	string	Deployment リージョンの ID。	cn-hangzhou
DeployedRevisionIds	string	デプロイ済みリビジョン ID のリスト。最近デプロイされたリビジョンのうち、最新の 10 件のみが表示されます。	["rev-f575b688015442d28d26","rev-b9876a39cf84490db638","rev-782fc7a0c0974d89b1eb"]
Description	string	アプリケーショングループの説明。	ApplicationGroup
ErrorDetail	string	ビルド失敗のエラー詳細。	ERROR: failed to build: executing lifecycle: failed with status code: 51
ErrorType	string	ビルド失敗のエラータイプ。	Build
ExecutionId	string	実行 ID。	exec-f5dee943869c436a9f57
ImportTagKey	string	タグキー。	k1
ImportTagValue	string	タグ値。	v1
MonitorMetadata	string	モニタリングメタデータ。	[{"CmsProject":"workspace1","CmsApplicationName":"default"}]
MonitorURL	string	モニタリング URL。	http//xxx.com
Name	string	アプリケーショングループの名前。	MyApplicationGroup
OperationMetadata	string	管理対象 O&M の構成。	{\"PrometheusConfigMap\":{\"テンプレート1\":{\"EnablePrometheus\":false}}}
Progress	string	アプリケーションインスタンスの作成の進行状況。	100
Status	string	アプリケーショングループのステータス。	Created
StatusReason	string	アプリケーショングループのステータスの詳細。	Stack CREATE completed successfully
UpdateDate	string	アプリケーショングループが最後に更新された時間。	2021-09-07T10:28:25Z
RequestId	string	リクエスト ID。	92EA60ED-544D-55E9-93D9-237BE9976C0D

例

成功レスポンス

JSONJSON

{
  "ApplicationGroup": {
    "ApplicationName": "MyApplication",
    "ApplicationSource": "{\"Platform\":\"github\",\"RepoName\":\"wenle/springboot-ecs-ソースコード-demo\",\"Owner\":\"wenle\",\"Branch\":\"main\",\"CommitHash\":\"8559ff3ac7568fc7951ff63f841883ee3f06c6fe\",\"CommitMessage\":\"ComputeNest プロジェクトの初期化\"}",
    "CmsGroupId": "12345678",
    "CreateDate": "2021-09-07T10:28:25Z",
    "DeployOutputs": "{       \"Outputs\": [         {           \"Description\": \"出力の説明なし\",           \"OutputKey\": \"InstanceIds\"         }       ],       \"StackId\": \"6ef4b860-f6e7-4145-8d22-f4a2a32363e1\"     }   }",
    "DeployParameters": "{       \"TemplateURL\": \"https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json\",       \"Parameters\": {         \"ZoneId\": \"cn-hangzhou-k\",         \"ProjectName\": \"テンプレートテスト\",         \"SystemDiskSize\": 40,         \"InstanceChargeType\": \"PostPaid\",         \"SecurityGroupId\": \"sg-bp1a4374akk63jl8tddy\",         \"VSwitchId\": \"vsw-bp1fcvc3zn0jrag86rrlm\",         \"SystemDiskCategory\": \"cloud_essd\",         \"InstancePassword\": \"******\",         \"InternetChargeType\": \"PayByTraffic\",         \"InstanceCount\": 1,         \"InternetMaxBandwidthOut\": 0,         \"VpcId\": \"vpc-bp1i99boyas8i8m9t3skp\",         \"EcsImageId\": \"centos_8_5_x64_20G_alibase_20211228.vhd\",         \"DataDiskSize\": 100,         \"EcsInstanceType\": \"ecs.s6-c1m4.small\",         \"DataDiskCategory\": \"cloud_efficiency\",         \"EnvironmentCommandId\": \"c-hz028fc3g031gcg\"       }",
    "DeployRegionId": "cn-hangzhou",
    "DeployedRevisionIds": "[\"rev-f575b688015442d28d26\",\"rev-b9876a39cf84490db638\",\"rev-782fc7a0c0974d89b1eb\"]",
    "Description": "アプリケーショングループ",
    "ErrorDetail": "エラー: ビルドに失敗しました: ライフサイクルの実行: ステータスコード 51 で失敗しました",
    "ErrorType": "ビルド",
    "ExecutionId": "exec-f5dee943869c436a9f57",
    "ImportTagKey": "k1",
    "ImportTagValue": "v1",
    "MonitorMetadata": "[{\"CmsProject\":\"workspace1\",\"CmsApplicationName\":\"default\"}]",
    "MonitorURL": "http//xxx.com",
    "Name": "MyApplicationGroup",
    "OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"テンプレート1\\\":{\\\"EnablePrometheus\\\":false}}}",
    "Progress": "100",
    "Status": "作成済み",
    "StatusReason": "スタックの作成が正常に完了しました",
    "UpdateDate": "2021-09-07T10:28:25Z"
  },
  "RequestId": "92EA60ED-544D-55E9-93D9-237BE9976C0D"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。