ModifyDBInstanceConnectionString - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

操作説明

また、Tair (Redis OSS-compatible) コンソールからインスタンスのエンドポイントまたはポート番号を変更することもできます。詳細については、「インスタンスのエンドポイントまたはポート番号の変更」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:ModifyDBInstanceConnectionString

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンスの ID です。	r-bp1zxszhcgatnx****
NewConnectionString	string	任意	新しいエンドポイントのプレフィックスです。`<prefix>.redis.rds.aliyuncs.com` の形式で指定してください。プレフィックスは 8 文字以上 40 文字以下で、小文字と数字のみ使用可能です。先頭は必ず小文字で始める必要があります。説明 NewConnectionString パラメーターと Port パラメーターのいずれか 1 つを必ず指定する必要があります。	standardredis123
CurrentConnectionString	string	必須	インスタンスの現在のエンドポイントです。	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
Port	string	任意	インスタンスのポート番号です。有効な値： 1024 ～ 65535。説明 NewConnectionString パラメーターと Port パラメーターのいずれか 1 つを必ず指定する必要があります。	6379
IPType	string	任意	エンドポイントのネットワークタイプです。有効な値： Private：内部ネットワーク Public：インターネット	Public

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	1790D68A-465C-44E3-BC24-9732652961F9

例

成功レスポンス

JSONJSON

{
  "RequestId": "1790D68A-465C-44E3-BC24-9732652961F9"
}

エラーレスポンス

JSONJSON

{
	"code": "200",
	"data": {
		"RequestId": "A7CCD05D-74FE-44DE-A4F0-C3EE58A252BE"
	},
	"successResponse": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NewConnectionStringNotSupport	Specified newConnectionString is not supported.
400	InvalidIPType.Format	Specified parameter IPType is not supported.
400	InvalidConnectionStringOrPort.Duplicate	Specified connection string or port want to be modified is the same with current net type.
400	InvalidConnectionString.Format	Specified connection string is not valid.

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

変更履歴

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