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

:AddHDMInstance

最終更新日:Dec 19, 2025

データベースインスタンスを Database Autonomy Service (DAS) に追加します。

操作説明

この操作を呼び出す前に、次の点にご注意ください。

  • Alibaba Cloud SDK または DAS SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。

  • SDK を使用して DAS を呼び出す場合は、リージョンを cn-shanghai に設定する必要があります。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:AddHDMInstance

create

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

__context

string

任意

予約済みパラメーター。

None

InstanceArea

string

必須

データベースがデプロイされているインスタンスのタイプ。有効な値:

  • RDS:Alibaba Cloud データベースインスタンス。

  • ECS:自己管理データベースがデプロイされている Elastic Compute Service (ECS) インスタンス。

  • IDC:Alibaba Cloud にデプロイされていない自己管理データベースインスタンス。

説明

IDC はデータセンターを指します。

ECS

InstanceId

string

任意

インスタンス ID。

rm-2ze1jdv45i7l6****

Ip

string

任意

内部ネットワーク経由でインスタンスにアクセスするために使用されるエンドポイント。

rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com

Port

string

任意

内部ネットワーク経由でインスタンスにアクセスするために使用されるポート。

3306

Engine

string

任意

データベースエンジン。有効な値:

  • MySQL

  • PostgreSQL

  • SQLServer

  • PolarDBMySQL

  • PolarDBPostgreSQL

  • Redis

  • MongoDB

  • PolarDBOracle

  • PolarDBX

MySQL

Username

string

任意

データベースへのログインに使用するユーザー名。

test****

Password

string

任意

ユーザー名のパスワード。

122****

InstanceAlias

string

任意

インスタンスの名前。

yuecq--test****

NetworkType

string

任意

インスタンスのネットワークタイプ。

VPC

VpcId

string

任意

Virtual Private Cloud (VPC) ID。

vpc-m5e666n89m2bx8jar****

Region

string

任意

インスタンスが存在するリージョンの ID。

cn-hangzhou

FlushAccount

string

任意

予約済みパラメーター。

None

レスポンスフィールド

フィールド

説明

object

Message

string

返されるメッセージ。

説明

リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。

Successful

RequestId

string

リクエスト ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****

Synchro

string

予約済みパラメーター。

None

Data

object

エラーコードや返されるエントリ数などの詳細情報。

VpcId

string

VPC ID。

vpc-m5e666n89m2bx8jar****

Token

string

リクエストのべき等性を保証するために使用されるクライアントトークン。

tokenID

Ip

string

インスタンスのエンドポイント。

rm-de21209****.mysql.rds.aliyuncs.com

CallerUid

string

API 呼び出し元のユーザー ID。

31063db679****

InstanceId

string

インスタンス ID。

rm-2ze1jdv45i7l6****

Port

integer

アクセスするインスタンスのポート番号。

3306

OwnerId

string

インスタンス所有者の ID。

325352345

Uuid

string

インスタンスの一意の識別子。

hdm_3063db6792965c080a4bcb6e6304****

Error

string

リクエストが失敗した場合に返されるエラーメッセージ。

InvalidRequestURL

Code

integer

返された HTTP ステータスコード。

200

Role

string

現在の API 呼び出し元のロール。

master

TenantId

string

テナント ID。

L0EPfLS****=SCE00000*****

Code

string

返された HTTP ステータスコード。

200

Success

string

リクエストが成功したかどうかを示します。有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

成功レスポンス

JSONJSON

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Synchro": "None",
  "Data": {
    "VpcId": "vpc-m5e666n89m2bx8jar****",
    "Token": "tokenID",
    "Ip": "rm-de21209****.mysql.rds.aliyuncs.com",
    "CallerUid": "31063db679****",
    "InstanceId": "rm-2ze1jdv45i7l6****",
    "Port": 3306,
    "OwnerId": "325352345",
    "Uuid": "hdm_3063db6792965c080a4bcb6e6304****",
    "Error": "InvalidRequestURL",
    "Code": 200,
    "Role": "master",
    "TenantId": "L0EPfLS****=SCE00000*****"
  },
  "Code": "200",
  "Success": "true"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParams The request parameters are invalid.
403 NoPermission You are not authorized to do this action.

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

変更履歴

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