DescribeInstanceAttribute を使用してインスタンス属性をクエリ - Bastionhost - Alibaba Cloud - Bastionhost

インスタンス ID やインスタンスの説明など、インスタンスのすべての属性情報を照会します。

操作説明

この操作の呼び出しにより、暗号化サービスインスタンスを購入できます。これは前払いプロダクトであり、料金は同期的に差し引かれます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-bastionhost:DescribeInstanceAttribute

get

*インスタンス。

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	クエリ対象の Bastion ホストインスタンスのリージョン ID。	cn-hangzhou
InstanceId	string	必須	クエリ対象の Bastion ホストインスタンスの ID。説明 DescribeInstances 操作の呼び出しにより、Bastion ホストインスタンス ID を取得できます。	bastionホスト-cn-78v1ghxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエストの ID。Alibaba Cloud は各リクエストに対して一意の識別子を生成します。この ID を使用して問題のトラブルシューティングができます。	082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttribute	object	インスタンスの属性情報。
VpcId	string	インスタンスがバインドされている VPC の ID。	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	インスタンスがバインドされている vSwitch の ID。	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	説明。	TestAPI
ExpireTime	integer	Bastion ホストインスタンスの有効期限タイムスタンプ。単位: ミリ秒。	1578326400000
ModifyPasswordModule	string	パスワード変更の特徴のステータス。 Enable: 有効。 Disable: 無効。	Enable
EniInstanceId	string	エラスティックネットワークインターフェース (ENI) の ID。これは、インスタンスにバインドされているネットワークインターフェースコントローラー (NIC) の ID です。	eni-bp1455jrzwm7moaxxxxx
InstanceId	string	インスタンス ID。	Bastion ホスト-cn-78v1ghxxxxx
InternetEndpoint	string	パブリックドメイン名。	******lwb-public.Bastion ホスト.aliyuncs.com
RegionId	string	インスタンスのリージョン ID。	cn-hangzhou
IntranetEndpoint	string	内部ドメイン名。	******xalwb.Bastion ホスト.aliyuncs.com
StartTime	integer	Bastion ホストインスタンスの購入または更新タイムスタンプ。単位: ミリ秒。	1577681345000
ResourceGroupId	string	インスタンスが属するリソースグループの ID。	rg-aekzc427db******
NetworkProxyModule	string	ネットワークドメインプロキシの特徴のステータス。 Enable: ネットワークドメインプロキシモードがサポートされています。 Disable: ネットワークドメインプロキシモードはサポートされていません。	Enable
WebTerminalModule	string	Web ターミナルの特徴のステータス。 Enable: Web リモート接続がサポートされています。 Disable: Web リモート接続はサポートされていません。	Enable
InstanceStatus	string	インスタンスステータス。有効な値: PENDING: 未初期化。 CREATING: 作成中。 RUNNING: 実行中。 EXPIRED: 期限切れ。 CREATE_FAILED: 作成に失敗した。 UPGRADING: スペックアップ中。 UPGRADE_FAILED: スペックアップに失敗した。	RUNNING
LicenseCode	string	ライセンスコード。	bhah_ent_50_asset
PublicNetworkAccess	boolean	Bastion ホストインスタンスがインターネット経由でアクセス可能かどうかを示します。有効な値: true: Bastion ホストはインターネット経由でアクセス可能です。 false: Bastion ホストはインターネット経由でアクセスできません。	true
Storage	integer	購入した Bastion ホストの合計ストレージ容量。単位: バイト。	2199023255552
Ports	array<object>	Bastion ホストの O&M ポート。
	object	Bastion ホストの O&M ポート。
StandardPort	integer	Bastion ホストの標準ポート。有効な値: SSH: 60022 RDP: 63389 HTTPS: 443	60022
CustomPort	integer	カスタムポート。説明 SSH ポートと RDP ポートのみ変更できます。Bastion ホストにカスタム O&M ポートが設定されていない場合、値は標準ポートと同じになります。	600xx
PublicExportIps	array	Bastion ホストのパブリックエグレス IP アドレスのリスト。
	string	Bastion ホストのパブリックエグレス IP アドレス。	[10.162.168.xx/32]
PublicWhiteList	array	Bastion ホストのパブリックホワイトリスト。
	string	Bastion ホストのパブリックホワイトリスト IP アドレス。	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	許可されたセキュリティグループ ID のリスト。
	string	許可されたセキュリティグループ ID。	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	Bastion ホストの内部エグレス IP アドレスのリスト。
	string	Bastion ホストの内部エグレス IP アドレス。	192.168.xx.xx
PublicIps	array	Bastion ホストのパブリック IP アドレスのリスト。
	string	Bastion ホストのパブリック IP アドレス。	116.62.xx.xx
SecurityGroupIds	array	インスタンスが属するセキュリティグループ ID のリスト。
	string	インスタンスが属するセキュリティグループ ID。	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	内部ホワイトリスト IP アドレスのリスト。
	string	内部ホワイトリスト IP アドレス。	192.168.xx.xx
Bandwidth	string	Bastion ホストインスタンスの合計帯域幅。	30
BandwidthPackage	string	Bastion ホストの拡張帯域幅パッケージ。	5
DbOperationModule	string	データベース O&M の特徴のステータス。 Enable: データベース O&M がサポートされています。 Disable: データベース O&M はサポートされていません。	Disable
RouterRules	array	Bastion ホストインスタンスのルールのリスト。
	string	Bastion ホストインスタンスのルールのリスト。
IDaaSModule	string	IDaaS 統合モジュール。有効な値: Enable、Disable。	Enable
SlaveVswitchId	string	Bastion ホストインスタンスにバインドされているセカンダリ vSwitch の ID。	vsw-uf6cmnae7hu5****
ScriptDeliverModule	string	スクリプト O&M モジュール。有効な値: Enable、Disable。	Enable
KmsSecretModule	string	KMS Secrets Manager 統合モジュール。有効な値: Enable、Disable。	Enable
RDModule	string	マルチアカウントモジュール。有効な値: Enable、Disable。	Enable
HSMModule	string	HSM ハードウェア暗号化モジュールのステータス。Bastion ホストが HSM と統合されているかどうかを示します。
WhiteListPolicies	array<object>	設定する IP アドレスホワイトリスト。
	object	設定する IP アドレスホワイトリスト。
Entry	string	設定する IP アドレスホワイトリスト。最大値 50 個の IP アドレスがサポートされています。複数の IP アドレスはコンマ (,) で区切ります。	94.74.xx.xx/32
Description	string	ホワイトリストルールの説明。	スクリプト
AppOperationModule	string	アプリケーション O&M モジュール。有効な値: Enable、Disable。	Enable
AiOpsModule	string	インテリジェント O&M モジュールスイッチ。有効な値: Enable、Disable。	Enable
AiCreditStatus	string	AI クレジットステータス。有効な値: Available、Exhausted。	Available

例

成功レスポンス

JSONJSON

{
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "InstanceAttribute": {
    "VpcId": "vpc-bp1c85tzgqu1bf5bxxxxx",
    "VswitchId": "vsw-bp1xfwzzfti0kjbfxxxxx",
    "Description": "TestAPI",
    "ExpireTime": 1578326400000,
    "ModifyPasswordModule": "Enable",
    "EniInstanceId": "eni-bp1455jrzwm7moaxxxxx",
    "InstanceId": "bastionhost-cn-78v1ghxxxxx",
    "InternetEndpoint": "******lwb-public.bastionhost.aliyuncs.com",
    "RegionId": "cn-hangzhou",
    "IntranetEndpoint": "******xalwb.bastionhost.aliyuncs.com",
    "StartTime": 1577681345000,
    "ResourceGroupId": "rg-aekzc427db******",
    "NetworkProxyModule": "Enable",
    "WebTerminalModule": "Enable",
    "InstanceStatus": "RUNNING",
    "LicenseCode": "bhah_ent_50_asset",
    "PublicNetworkAccess": true,
    "Storage": 2199023255552,
    "Ports": [
      {
        "StandardPort": 60022,
        "CustomPort": 0
      }
    ],
    "PublicExportIps": [
      "[10.162.168.xx/32]"
    ],
    "PublicWhiteList": [
      "[10.162.168.xx/32]"
    ],
    "AuthorizedSecurityGroups": [
      "[sg-bp14u00sh39jvw5xxxxx]"
    ],
    "PrivateExportIps": [
      "192.168.xx.xx"
    ],
    "PublicIps": [
      "116.62.xx.xx"
    ],
    "SecurityGroupIds": [
      "sg-bp15ed6xe1yxeycg7o****"
    ],
    "PrivateWhiteList": [
      "192.168.xx.xx"
    ],
    "Bandwidth": "30",
    "BandwidthPackage": "5",
    "DbOperationModule": "Disable",
    "RouterRules": [
      ""
    ],
    "IDaaSModule": "Enable",
    "SlaveVswitchId": "vsw-uf6cmnae7hu5****",
    "ScriptDeliverModule": "Enable",
    "KmsSecretModule": "Enable",
    "RDModule": "Enable",
    "HSMModule": "",
    "WhiteListPolicies": [
      {
        "Entry": "94.74.xx.xx/32",
        "Description": "description"
      }
    ],
    "AppOperationModule": "Enable",
    "AiOpsModule": "Enable",
    "AiCreditStatus": "Available"
  }
}

エラーコード

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

変更履歴

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