すべてのプロダクト
Search
ドキュメントセンター

Bastionhost:API の概要

最終更新日:Jun 10, 2026

API 標準および多言語対応の SDK

本製品 (Yundun-bastionhost/2019-12-09) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。

カスタム署名

署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID:147535001692) までお問い合わせください。

はじめに

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。

API セキュリティを確保するには、以下を作成し、設定する必要があります。

Bastionhostインスタンス(V3.2.Xのみ)

API

タイトル

説明

DescribeInstanceAttribute DescribeInstanceAttribute インスタンス ID や説明など、すべてのインスタンス属性を返します。
DescribeInstances DescribeInstances Bastionhost インスタンスのリストを取得します。
ConfigInstanceSecurityGroups ConfigInstanceSecurityGroups 指定された Bastionhost インスタンスのセキュリティグループを設定します。
ConfigInstanceWhiteList ConfigInstanceWhiteList Bastionhost インスタンスのパブリックネットワークアクセスを有効化した後、IP アドレスホワイトリストに IP アドレスを追加して、アクセスを制御できます。
StartInstance StartInstance 指定された Bastionhost インスタンスを起動します。
EnableInstancePublicAccess EnableInstancePublicAccess 指定された Bastionhost インスタンスに対するパブリックネットワークアクセスを有効化します。
DisableInstancePublicAccess DisableInstancePublicAccess Bastionhost インスタンスのパブリックネットワークアクセスを無効化します。
ModifyInstanceAttribute ModifyInstanceAttribute 指定された Bastionhost インスタンスの属性を変更します。
MoveResourceGroup MoveResourceGroup 指定されたリソースグループに Bastionhost インスタンスを移動します。
AddInstanceRdMember AddInstanceRdMember Resource Directory (RD) のメンバーアカウントを追加します。
ListInstanceRdMembers ListInstanceRdMembers リソースディレクトリのメンバーアカウントを一覧表示します。
RemoveInstanceRdMember RemoveInstanceRdMember RD メンバーアカウントを削除します。

タグ(V3.2.Xのみ)

API

タイトル

説明

ListTagKeys ListTagKeys リソースに設定されているタグキーを照会します。
ListTagResources ListTagResources Bastionhost インスタンス 1 台以上にアタッチされたタグの一覧を取得します。
UntagResources UntagResources 1 つ以上の Bastionhost インスタンスからタグを削除します。特定のキーと値のペアのタグ、またはすべてのタグを一度に削除できます。
TagResources TagResources Bastionhost インスタンス 1 台以上にタグを作成・アタッチします。

リージョン(V3.2.Xのみ)

API

タイトル

説明

DescribeRegions DescribeRegions Bastionhost が利用可能な Alibaba Cloud リージョンを照会します。

ホスト(V3.2.17以降)

API

タイトル

説明

CreateHost CreateHost Bastionhost を使用すると、Alibaba Cloud ECS サーバー、オンプレミスサーバー、他のクラウドプロバイダーのサーバーなど、さまざまなソースのホストを管理できます。ホストを管理する前に、ホストを Bastionhost にインポートする必要があります。この操作を呼び出して、Bastionhost でホストを作成できます。
GetHost GetHost ホストの名前、ソース、アドレス、プロトコル、サービスポートなどのホスト詳細を照会します。
ListHosts ListHosts 踏み台ホスト内のホストを照会します。
DeleteHost DeleteHost ホストを削除します。
ModifyHostsPort ModifyHostsPort 1 つ以上のホストの O&M プロトコルのポートを変更します。
ModifyHostsActiveAddressType ModifyHostsActiveAddressType O&M 用のホストのエンドポイントタイプを変更します。パブリック IP アドレスおよびプライベート IP アドレスがサポートされます。
ModifyHost ModifyHost ホストの情報を変更します。変更可能な情報には、ホストのアドレス、名前、説明、およびホストが実行するオペレーティングシステムが含まれます。

データベース(バージョン3.2.40以降)

API

タイトル

説明

CreateDatabase CreateDatabase この操作を呼び出して、データベース資産を Bastionhost にインポートできます。RDS for MySQL、SQL Server、PostgreSQL などの Alibaba Cloud データベースや、PolarDB for MySQL、PostgreSQL、PostgreSQL (Oracle 互換) をインポートできます。また、MySQL、SQL Server、PostgreSQL、または Oracle を実行する自己管理データベースをインポートすることもできます。
ModifyDatabase ModifyDatabase データベースの基本情報を変更します。
GetDatabase GetDatabase データベースの詳細情報を照会します。
ListDatabases ListDatabases 踏み台ホストによって管理されているデータベースを照会します。
DeleteDatabase DeleteDatabase データベースを削除します。

ネットワークドメイン(V3.2.40以降)

API

タイトル

説明

CreateNetworkDomain CreateNetworkDomain 異なるネットワークに存在するアセットや、踏み台ホストの仮想プライベートクラウド (VPC) と通信できないアセットに対して、運用保守 (O&M) 操作を一元的に実行したい場合、Bastionhost のネットワークドメイン機能の使用を推奨します。これらのアセット用にプロキシサーバーを設定し、踏み台ホストのネットワークドメインを作成後、そのネットワークドメインをプロキシサーバーに接続することで、踏み台ホスト経由でアセットの O&M 操作を実行できるようになります。
GetNetworkDomain GetNetworkDomain 指定されたネットワークドメインの詳細を取得します。
ListNetworkDomains ListNetworkDomains 指定された Bastionhost インスタンスのネットワークドメインを一覧表示します。
DeleteNetworkDomain DeleteNetworkDomain ネットワークドメインを削除します。
ModifyNetworkDomain ModifyNetworkDomain ネットワークドメインの基本情報を変更します。
MoveHostsToNetworkDomain MoveHostsToNetworkDomain 複数のホストを一度にネットワークドメインに追加します。
MoveDatabasesToNetworkDomain MoveDatabasesToNetworkDomain 複数のデータベースを一度にネットワークドメインに追加します。

ホストアカウント(V3.2.17以降)

API

タイトル

説明

CreateHostAccount CreateHostAccount Bastionhost でホストを作成した後、そのホストのホストアカウントを作成できます。これにより、ホスト上の既存のアカウントが Bastionhost の管理下に置かれます。ホストアカウントが作成されると、運用保守 (O&M) エンジニアはそのアカウントを使用して Bastionhost 経由でホストにログインできます。
GetHostAccount GetHostAccount 指定されたホストアカウントの詳細を取得します。
ListHostAccounts ListHostAccounts ホストアカウントのリストをクエリします。
ModifyHostAccount ModifyHostAccount ホストアカウントの名称、パスワード、秘密鍵など、ホストアカウント情報を変更します。
DeleteHostAccount DeleteHostAccount ホストアカウントを削除します。
ResetHostAccountCredential ResetHostAccountCredential 指定されたホストアカウントの認証情報 (パスワードまたは SSH 秘密鍵) をクリアします。

データベースアカウント(V3.2.40以降)

API

タイトル

説明

CreateDatabaseAccount CreateDatabaseAccount データベースを作成した後、そのデータベース用のデータベースアカウントを作成できます。アカウントが作成されると、運用保守エンジニアはそのアカウントを使用してデータベースにログインし、運用保守操作を実行できます。
ModifyDatabaseAccount ModifyDatabaseAccount データベースアカウントの基本情報を変更します。
GetDatabaseAccount GetDatabaseAccount データベースアカウントの詳細情報をクエリします。
ListDatabaseAccounts ListDatabaseAccounts データベースのデータベースアカウントを照会します。
ListDatabaseAccountsForUserGroup ListDatabaseAccountsForUserGroup 指定されたデータベースのデータベースアカウントと、各データベースアカウントを管理する権限がユーザーグループに付与されているかどうかを照会します。
DeleteDatabaseAccount DeleteDatabaseAccount データベースアカウントを削除します。

ユーザー(バージョン3.2.17以降)

API

タイトル

説明

CreateUser CreateUser 踏み台ホストにユーザーを追加します。
GetUser GetUser 指定された踏み台ホストのユーザーの詳細を照会します。
ListUsers ListUsers 堡垒ホストのユーザー一覧をクエリします。
ModifyUser ModifyUser 踏み台ホストのユーザー情報を変更します。
DeleteUser DeleteUser 踏み台ホストのユーザーを削除します。
CreateUserPublicKey CreateUserPublicKey 要塞ホストのユーザーに対して公開鍵を作成し、要塞ホストに登録します。これにより、運用保守エンジニアは、運用保守クライアントから、この公開鍵に対応する秘密鍵を使用して要塞ホストにログインできるようになります。
ListUserPublicKeys ListUserPublicKeys ユーザーのすべての公開鍵をクエリします。
ModifyUserPublicKey ModifyUserPublicKey ユーザーの公開鍵を変更します。
DeleteUserPublicKey DeleteUserPublicKey 指定されたユーザーから公開鍵を削除します。
LockUsers LockUsers bastion host の 1 つ以上のユーザーをロックします。
UnlockUsers UnlockUsers バスティオンホストのユーザーを1人以上ロック解除します。

ユーザーグループ(V3.2.17以降)

API

タイトル

説明

CreateUserGroup CreateUserGroup 踏み台ホストのユーザーグループを作成します。
GetUserGroup GetUserGroup Bastion Host のユーザーグループの詳細を取得します。
ListUserGroups ListUserGroups Bastion ホスト上のユーザーグループのリストをクエリします。
ModifyUserGroup ModifyUserGroup ユーザーグループの情報を変更します。
DeleteUserGroup DeleteUserGroup 踏み台ホストからユーザーグループを削除します。
AddUsersToGroup AddUsersToGroup 1 つ以上のユーザーをユーザーグループに追加します。
RemoveUsersFromGroup RemoveUsersFromGroup ユーザーグループから 1 名以上のユーザーを削除します。

アセットグループ(V3.2.17以降)

API

タイトル

説明

CreateHostGroup CreateHostGroup ビジネス要件に基づいて資産グループを作成し、同じタイプの資産を資産グループに追加できます。これにより、資産を分類し、複数の資産を一度に管理することが可能になります。
AddDatabasesToGroup AddDatabasesToGroup 指定されたアセットグループに複数のデータベースを追加します。
AddHostsToGroup AddHostsToGroup 指定されたホストグループに 1 つ以上のホストを追加します。
RemoveDatabasesFromGroup RemoveDatabasesFromGroup 資産グループから複数のデータベースを一度に削除します。
DeleteHostGroup DeleteHostGroup ホストグループを削除します。
RemoveHostsFromGroup RemoveHostsFromGroup 一度に複数のホストをアセットグループから削除します。
ModifyHostGroup ModifyHostGroup 指定されたホストグループの名前または説明を変更します。
GetHostGroup GetHostGroup 指定されたホストグループの詳細情報をクエリします。
ListHostGroups ListHostGroups バスタイオンホストが管理する資産グループの一覧をクエリします。

ホスト権限付与(V3.2.17以降)

API

タイトル

説明

AttachHostAccountsToUser AttachHostAccountsToUser ユーザーを踏み台ホストに追加した後、そのユーザーにアセットを管理する権限を付与する必要があります。権限が付与されたユーザーのみが踏み台ホストにログインし、アセットに対して運用保守操作を実行できます。
ListHostsForUser ListHostsForUser ユーザーグループが管理を許可されている、または許可されていないホストを照会します。
ListHostAccountsForUser ListHostAccountsForUser ホストに属するホストアカウントと、指定ユーザーに各ホストアカウントの管理権限が付与されているかどうかを照会します。
DetachHostAccountsFromUser DetachHostAccountsFromUser ユーザーからホストおよびホストアカウントに対する権限を取り消します。
DetachHostAccountsFromUserGroup DetachHostAccountsFromUserGroup ユーザーグループから 1 つ以上のホストおよびホストアカウントの権限を取り消します。
DetachHostGroupAccountsFromUser DetachHostGroupAccountsFromUser ユーザーが管理可能なホストグループおよびホストアカウントのリストから、対象のホストグループとホストアカウントを削除します。
AttachHostAccountsToUserGroup AttachHostAccountsToUserGroup ユーザーグループに、1 つ以上のホストおよびホストアカウントを管理する権限を付与します。
DetachHostGroupAccountsFromUserGroup DetachHostGroupAccountsFromUserGroup ユーザーグループから、1 つ以上のホストグループおよびホストアカウントに対する権限を取り消します。
AttachHostGroupAccountsToUser AttachHostGroupAccountsToUser ユーザーに 1 つ以上のホストグループおよびホストアカウントの管理権限を付与します。
AttachHostGroupAccountsToUserGroup AttachHostGroupAccountsToUserGroup ユーザーが1つ以上のホストグループおよびホストアカウントを管理することを承認します。
ListHostAccountsForUserGroup ListHostAccountsForUserGroup ホストのホストアカウント、およびユーザーグループに各ホストアカウントの管理権限が付与されているかどうかを照会します。
ListHostGroupAccountNamesForUser ListHostGroupAccountNamesForUser 指定されたホストグループ内で、指定されたユーザーが管理権限を持つホストアカウントの名前をクエリします。
ListHostGroupAccountNamesForUserGroup ListHostGroupAccountNamesForUserGroup ユーザーグループがホストグループ内で管理権限を持つホストアカウントの名前をクエリします。
ListHostGroupsForUser ListHostGroupsForUser 踏み台ホストのユーザーに管理権限が付与されている、または付与されていないホストグループのリストをクエリします。
ListHostGroupsForUserGroup ListHostGroupsForUserGroup 指定されたユーザーグループが管理を許可されている、または許可されていないホストグループをクエリします。
ListHostsForUserGroup ListHostsForUserGroup ユーザーグループに管理権限がある、または管理権限がないホストを照会します。

データベース権限付与(V3.2.40以降)

API

タイトル

説明

AttachDatabaseAccountsToUser AttachDatabaseAccountsToUser ユーザーにデータベースとデータベースアカウントを管理する権限を付与します。
ListDatabasesForUser ListDatabasesForUser 指定されたユーザーが管理権限を持つデータベースをクエリします。
DetachDatabaseAccountsFromUserGroup DetachDatabaseAccountsFromUserGroup ユーザーグループからデータベースおよびデータベースアカウントに対する権限を取り消します。
ListDatabaseAccountsForUser ListDatabaseAccountsForUser 指定されたデータベースのデータベースアカウントと、特定のユーザーが各データベースアカウントを管理する権限を持っているかどうかを照会します。
DetachDatabaseAccountsFromUser DetachDatabaseAccountsFromUser ユーザーからデータベースおよびデータベースアカウントに対する権限を取り消します。
AttachDatabaseAccountsToUserGroup AttachDatabaseAccountsToUserGroup データベースおよびデータベースアカウントに対する権限をユーザーグループに付与します。
ListDatabasesForUserGroup ListDatabasesForUserGroup ユーザーグループに許可されているデータベースのリストを照会します。

運用保守トークン(V3.2.40以降)

API

タイトル

説明

ListOperationDatabases ListOperationDatabases 現在の Resource Access Management (RAM) ユーザーがアクセスを許可されているデータベースを一覧表示します。
ListOperationHosts ListOperationHosts 現在の Resource Access Management (RAM) ユーザーがアクセスを許可されているホストのリストを照会します。
ListOperationHostAccounts ListOperationHostAccounts 現在の Resource Access Management (RAM) ユーザーが管理を許可されているホストアカウントのリストを照会します。
ListOperationDatabaseAccounts ListOperationDatabaseAccounts 現在の Resource Access Management (RAM) ユーザーが管理を許可されているデータベースアカウントのリストを照会します。
GenerateAssetOperationToken GenerateAssetOperationToken このオペレーションを呼び出して、アセット管理用のバスティオンまたはデータベースの O&M トークンをリクエストします。
RenewAssetOperationToken RenewAssetOperationToken O&M トークンを 1 時間更新します。
CreateOperationTicket CreateOperationTicket 管理者が O&M 承認を要求するコントロールポリシーを設定した場合、O&M エンジニアは O&M チケットを作成する必要があります。エンジニアは、管理者がチケットを承認した後にのみ O&M タスクを実行できます。

権限付与ルール(V3.2.40以降)

API

タイトル

説明

CreateRule CreateRule 権限付与ルールを作成することで、複数のユーザーに資産の管理権限を付与できます。権限付与ルールには有効期間を指定することも可能です。これにより、ユーザーと資産をより効率的に管理し、ユーザーが資産にアクセスできる期間を制限できます。
ModifyRule ModifyRule 権限付与ルールの基本情報を変更します。
GetRule GetRule 権限付与ルールの詳細情報をクエリします。
ListRules ListRules 踏み台ホストの権限付与ルールのリストを照会します。
EnableRule EnableRule 権限付与ルールを有効化します。
DisableRule DisableRule 権限付与ルールを無効にします。
DeleteRule DeleteRule 権限付与ルールを削除します。

制御ポリシー(V3.2.40以降)

API

タイトル

説明

CreatePolicy CreatePolicy コマンドコントロール、コマンド承認、プロトコルコントロール、またはアクセス制御ポリシーを設定して、運用保守 (O&M) 操作を管理します。 これにより、ユーザーによる高リスク操作や偶発的な操作を効果的に防止し、運用保守 (O&M) のセキュリティを確保します。
ModifyPolicy ModifyPolicy コントロールポリシーの基本情報を変更します。
GetPolicy GetPolicy 指定されたコントロールポリシーの詳細を取得します。
ListPolicies ListPolicies コントロールポリシーのリストを照会します。
GetPolicyAssetScope GetPolicyAssetScope コントロールポリシーが適用されるアセットをクエリします。
SetPolicyProtocolConfig SetPolicyProtocolConfig コントロールポリシーの RDP (Remote Desktop Protocol)、SSH (Secure Shell)、および SFTP (SSH File Transfer Protocol) オプションを設定します。
SetPolicyCommandConfig SetPolicyCommandConfig ポリシーに関連付けられたユーザーまたは資産が実行できるコマンド、実行できないコマンド、およびレビューが必要なコマンドを指定します。
SetPolicyIPAclConfig SetPolicyIPAclConfig コントロールポリシーが適用されるアセットにソース IP アドレスがアクセスできるかどうかを指定します。
GetPolicyUserScope GetPolicyUserScope コントロールポリシーが適用されるユーザーの範囲を照会します。
SetPolicyAccessTimeRangeConfig SetPolicyAccessTimeRangeConfig コントロールポリシーのログイン期間制限を設定します。
SetPolicyAssetScope SetPolicyAssetScope コントロールポリシーが適用される資産を指定します。
SetPolicyUserScope SetPolicyUserScope コントロールポリシーを適用するユーザーを指定します。
SetPolicyApprovalConfig SetPolicyApprovalConfig コントロールポリシーの O&M 承認設定を構成します。
DeletePolicy DeletePolicy コントロールポリシーを削除します。

承認(V3.2.37以降)

API

タイトル

説明

ListApproveCommands ListApproveCommands 審査待ちのコマンドをクエリします。
AcceptApproveCommand AcceptApproveCommand 運用保守エンジニアが「コントロールポリシーの作成」ページで「コマンド承認」フィールドに指定されたコマンドを実行しようとすると、管理者に通知が届き、Bastionhost コンソールでコマンドをレビューするよう求められます。コマンドは、管理者によって承認された後にのみ実行できます。
RejectApproveCommand RejectApproveCommand 運用保守エンジニアが「制御ポリシーの作成」ページの「コマンド承認」セクションで指定されたコマンドを実行しようとすると、管理者に通知が送られ、Bastionhost コンソールでコマンドをレビューするよう求められます。コマンドは、管理者の承認後にのみ実行できます。
ListOperationTickets ListOperationTickets 承認が必要な O&M リクエストを一覧表示します。
AcceptOperationTicket AcceptOperationTicket O&M アプリケーションを承認します。
RejectOperationTicket RejectOperationTicket Bastionhost 管理者が「制御ポリシーの作成」ページで O&M 承認機能を有効化すると、O&M エンジニアは、管理者による O&M 申請の承認を受けるまで、資産へのログインおよび O&M 操作を実行できません。

共有キー(V3.2.Xのみ)

API

タイトル

説明

CreateHostShareKey CreateHostShareKey Bastionhost は共有キー機能を提供します。この機能を使用すると、Bastionhost のホストへのログインに使用される秘密鍵を管理できます。これにより、秘密鍵をホストの複数のアカウントに関連付けて、ホストアカウントの管理をより効率的にすることができます。
GetHostShareKey GetHostShareKey 共有キーに関する情報を照会します。
ListHostShareKeys ListHostShareKeys ホストに関連付けられている共有キーを照会します。
ListHostAccountsForHostShareKey ListHostAccountsForHostShareKey 共有キーに関連付けられているホストアカウントをクエリします。
ModifyHostShareKey ModifyHostShareKey 共有キーを変更します。
AttachHostAccountsToHostShareKey AttachHostAccountsToHostShareKey ホストアカウントを共有キーに関連付けます。
DetachHostAccountsFromHostShareKey DetachHostAccountsFromHostShareKey 共有キーからホストアカウントの関連付けを解除します。
DeleteHostShareKey DeleteHostShareKey 共有キーを削除します。

システム設定(V3.2.Xを実行する踏み台ホストでのみ使用可能)

API

タイトル

説明

GetInstanceADAuthServer GetInstanceADAuthServer 踏み台ホストの Active Directory (AD) 認証設定をクエリします。
ModifyInstanceADAuthServer ModifyInstanceADAuthServer 踏み台ホストの Active Directory (AD) 認証サーバーの設定を変更します。
GetInstanceTwoFactor GetInstanceTwoFactor 踏み台ホストの二要素認証の設定を照会します。
ModifyInstanceTwoFactor ModifyInstanceTwoFactor 踏み台ホストの二要素認証設定を変更します。
ModifyInstanceLDAPAuthServer ModifyInstanceLDAPAuthServer 踏み台サーバーの Lightweight Directory Access Protocol (LDAP) 認証サーバーの設定を更新します。
GetInstanceLDAPAuthServer GetInstanceLDAPAuthServer 踏み台サーバーの Lightweight Directory Access Protocol (LDAP) 認証の設定を照会します。
GetInstanceStoreInfo GetInstanceStoreInfo Bastionhost インスタンスのストレージ使用量をクエリします。
CreateExportConfigJob CreateExportConfigJob 構成バックアップエクスポートタスクを作成します。Bastionhost インスタンスごとに、一度に実行できる構成バックアップエクスポートタスクは 1 つだけです。
GetExportConfigJob GetExportConfigJob null

その他

API

タイトル

説明

VerifyInstanceLDAPAuthServer VerifyInstanceLDAPAuthServer Bastionhost インスタンスに設定された Lightweight Directory Access Protocol (LDAP) 認証サーバーへの接続性をテストします。この操作を使用して、LDAP 設定を保存する前に検証します。
VerifyInstanceADAuthServer VerifyInstanceADAuthServer Bastionhost インスタンスに設定された Active Directory (AD) 認証サーバーへの接続性をテストします。この操作を使用して、AD 設定を保存する前に検証します。