GetApplication API によるアプリケーション詳細の取得 - CADT

指定されたアプリケーションの基本情報、検証結果、課金結果、およびデプロイメント結果を取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bpstudio:GetApplication

get

*Application

acs:bpstudio::{#accountId}:application/{#ApplicationId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApplicationId	string	必須	アプリケーション ID。	VVK605ZH00OA4MRT
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmyjt3c5om3hi

レスポンスフィールド

フィールド	型	説明	例
	object
Message	string	リクエストが失敗した原因。	Success
RequestId	string	リクエスト ID。	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	object	アプリケーションの詳細。
Description	string	アプリケーションの説明。	remark
ImageURL	string	データベース内のイメージの URL。	https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png
ApplicationId	string	アプリケーション ID。	VVK605ZH00OA4MRT
Name	string	アプリケーション名。	CADT
TemplateId	string	アプリケーションに関連付けられているテンプレートの ID。	FYS9VZ535U20V7HT
CreateTime	string	アプリケーションが作成された時刻。	2021-08-09 14:37:16
ResourceGroupId	string	アプリケーションが属するリソースグループの ID。	rg-aekzhfgmw4e6fwq
PriceList	array<object>	課金結果のリスト。
	object
ResourceCode	string	プロダクトコード。	ecs
InstanceName	string	インスタンス名。	ecs
OriginalPrice	number	元の価格。	3.570
OnePrice	number	単価。	0.01
Period	integer	期間。	1
Count	integer	数量。	1
PriceUnit	string	価格の単位。 USD/時間	200/hour
Price	number	合計価格。	0.01
ChargeType	string	課金方法。	PayAsYouGo
Region	string	リージョン。	cn-hangzhou
Specification	string	インスタンス仕様。例えば、VPC の場合は "192.168.0.0/16" のような CIDR ブロックが返されます。 ECS インスタンスの場合は "ecs.g5.large" のようなインスタンスタイプが返されます。 SLB インスタンスの場合は "slb.s1.small" のようなインスタンスタイプが返されます。インスタンスに仕様プロパティがない場合は、空の文字列が返されます。	"slb.s1.small" "192.168.0.0/24" "ecs.c6.large" "normal" ""
Lifecycle	string	リソースタグ。	Create
Remark	string	価格照会が失敗した場合に返されるエラーメッセージ。	ecs Sold Out
type	string	作成タイプ。有効値： 1: 作成 2: インポート	1
Checklist	array<object>	検証結果のリスト。
	object	検証結果のリスト。
ResourceCode	string	プロダクトコード。	vpc
ResourceName	string	インスタンス名。	vpc
Region	string	リージョン。	cn-hangzhou
Result	string	検証結果。	Finish
Remark	string	失敗の原因。	Verification passed
Specification	string	仕様。	192.168.0.0/16
Lifecycle	string	リソースタグ。	Create
Status	string	アプリケーションステータス。	Deployed_Success
ResourceList	array<object>	リソースのリスト。
	object	リソースのリスト。
Status	string	リソースのデプロイ結果。	Finish
ResourceCode	string	プロダクトコード。	ecs
ResourceName	string	インスタンス名。	ecs
ResourceId	string	インスタンス ID。	i-2zehnzxqixu1pywsfbx1
ChargeType	string	課金方法。	PayAsYouGo
ResourceType	string	リソースタイプ。	ecs
Remark	string	デプロイ結果。	{"hostName":"iZ2zehnzxqixu1pywsfbx1Z","memory":32768.0,"creationTime":"2021-09-28T11:23:46Z","instanceName":"ecs","internetMaxBandwidthOut":0.0,"description":"","clusterId":"","private_ip":"192.168.0.247","instanceId":"i-2zehnzxqixu1pywsfbx1","requestId":"F1C64344-3723-51A0-855B-5F08B5634323","zoneId":"cn-beijing-b","ioOptimized":"optimized","id":"i-2zehnzxqixu1pywsfbx1","instanceNetworkType":"vpc","instanceChargeType":"PostPaid","imageId":"centos_8_4_x64_20G_alibase_20210824.vhd","serialNumber":"cee246c4-38f3-4bf3-950b-c17e88ff6527","vlanId":"","instanceType":"ecs.e3.large","cpu":4.0,"creditSpecification":"","internetMaxBandwidthIn":-1.0,"expiredTime":"2099-12-31T15:59Z","internetChargeType":"PayByTraffic","regionId":"cn-beijing","refId":"79224644_0","stoppedMode":"Not-applicable","status":"Running"}
Lifecycle	string	リソースタグ。	Create
NodeLabel	string
Error	string	失敗の原因。	Success
DeployPercent	number	デプロイの進捗状況。	0.8
ComplianceList	array<object>	コンプライアンスチェック結果。
	array<object>
Rules	array<object>	チェック結果。
	object
ruleId	string	ルール ID。	ecs-instances-in-vpc
ruleDetail	string	ルール名。
ResourceName	string	リソース名。	ecs
ResourceCode	string	プロダクトコード。	ecs
Code	string	応答コード。	200

アプリケーションステータス：

Creating：アプリケーションは作成中です。
Modified：アプリケーションは変更済みです。
Verifying：アプリケーションは検証中です。
Verified_Failure：検証に失敗しました。
Verified_Success：検証に成功しました。
Valuating：価格は計算中です。
Valuating_Failure：価格計算に失敗しました。
Valuating_Success：価格計算に成功しました。
Deploying：アプリケーションはデプロイ中です。
Deployed_Failure：デプロイに失敗しました。
Partially_Deployed_Success：アプリケーションは部分的にデプロイされました。
Deployed_Success：デプロイに成功しました。
Destroying：アプリケーションはリリース中です。
Delayed_Destroy：アプリケーションはリリースがスケジュールされています。
Destroyed_Failure：リリースに失敗しました。
Partially_Destroyed_Success：アプリケーションは部分的にリリースされました。
Destroyed_Success：リリースに成功しました。
Revised：アーキテクチャは調整中です。
Verifying_In_Revision：アーキテクチャ調整のため、リソースの検証が進行中です。
Verified_Failure_In_Revision：アーキテクチャ調整のため、リソースの検証に失敗しました。
Verified_Success_In_Revision：アーキテクチャ調整後、リソースの検証に成功しました。
Valuating_In_Revision：アーキテクチャ調整のため、価格照会が進行中です。
Valuating_Failure_In_Revision：アーキテクチャ調整のため、価格照会に失敗しました。
Valuating_Success_In_Revision：アーキテクチャ調整後、価格照会に成功しました。

例

成功レスポンス

JSONJSON

{
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": {
    "Description": "remark",
    "ImageURL": "https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png",
    "ApplicationId": "VVK605ZH00OA4MRT",
    "Name": "CADT",
    "TemplateId": "FYS9VZ535U20V7HT",
    "CreateTime": "2021-08-09 14:37:16",
    "ResourceGroupId": "rg-aekzhfgmw4e6fwq",
    "PriceList": [
      {
        "ResourceCode": "ecs",
        "InstanceName": "ecs",
        "OriginalPrice": 3.57,
        "OnePrice": 0.01,
        "Period": 1,
        "Count": 1,
        "PriceUnit": "200/hour",
        "Price": 0.01,
        "ChargeType": "PayAsYouGo",
        "Region": "cn-hangzhou",
        "Specification": "\"slb.s1.small\"\n \"192.168.0.0/24\"\n\"ecs.c6.large\"\n\"normal\"\n \"\"",
        "Lifecycle": "Create",
        "Remark": "ecs Sold Out",
        "type": "1"
      }
    ],
    "Checklist": [
      {
        "ResourceCode": "vpc",
        "ResourceName": "vpc",
        "Region": "cn-hangzhou",
        "Result": "Finish",
        "Remark": "Verification passed",
        "Specification": "192.168.0.0/16",
        "Lifecycle": "Create"
      }
    ],
    "Status": "Deployed_Success",
    "ResourceList": [
      {
        "Status": "Finish",
        "ResourceCode": "ecs",
        "ResourceName": "ecs",
        "ResourceId": "i-2zehnzxqixu1pywsfbx1",
        "ChargeType": "PayAsYouGo",
        "ResourceType": "ecs",
        "Remark": "{\"hostName\":\"iZ2zehnzxqixu1pywsfbx1Z\",\"memory\":32768.0,\"creationTime\":\"2021-09-28T11:23:46Z\",\"instanceName\":\"ecs\",\"internetMaxBandwidthOut\":0.0,\"description\":\"\",\"clusterId\":\"\",\"private_ip\":\"192.168.0.247\",\"instanceId\":\"i-2zehnzxqixu1pywsfbx1\",\"requestId\":\"F1C64344-3723-51A0-855B-5F08B5634323\",\"zoneId\":\"cn-beijing-b\",\"ioOptimized\":\"optimized\",\"id\":\"i-2zehnzxqixu1pywsfbx1\",\"instanceNetworkType\":\"vpc\",\"instanceChargeType\":\"PostPaid\",\"imageId\":\"centos_8_4_x64_20G_alibase_20210824.vhd\",\"serialNumber\":\"cee246c4-38f3-4bf3-950b-c17e88ff6527\",\"vlanId\":\"\",\"instanceType\":\"ecs.e3.large\",\"cpu\":4.0,\"creditSpecification\":\"\",\"internetMaxBandwidthIn\":-1.0,\"expiredTime\":\"2099-12-31T15:59Z\",\"internetChargeType\":\"PayByTraffic\",\"regionId\":\"cn-beijing\",\"refId\":\"79224644_0\",\"stoppedMode\":\"Not-applicable\",\"status\":\"Running\"}",
        "Lifecycle": "Create",
        "NodeLabel": ""
      }
    ],
    "Error": "Success",
    "DeployPercent": 0.8,
    "ComplianceList": [
      {
        "Rules": [
          {
            "ruleId": "ecs-instances-in-vpc",
            "ruleDetail": ""
          }
        ],
        "ResourceName": "ecs",
        "ResourceCode": "ecs"
      }
    ]
  },
  "Code": "200"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	bp.java.8004	No permissions.
400	bp.java.nopower	No permissions.
400	bp.java.nopowerContact	You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.
400	bp.java.userNotExist	The user does not exist. The current user does not authenticate AliCloud with his real name.
400	ParameterEmpty	The request parameter cannot be empty.
500	ServiceError	A server error occurred. Please try again later.
404	EntityNotExist.ResourceGroup	The resource group does not exist.
404	EntityNotExist.ResourceId	The resource does not exist.

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

変更履歴

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