ModifyDBClusterDescriptionZonal API で PolarDB クラスターの説明を更新 - PolarDB - Alibaba Cloud - PolarDB

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:ModifyDBClusterDescriptionZonal

update

*All resources.

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。説明注意: この API オペレーションはエッジクラスターにのみ適用されます。エッジクラスターは、CreateDBCluster(CloudProvider=ENS, EnsRegionId=xxx) を呼び出して作成する必要があり、DescribeDBClustersZonal を呼び出して照会できます。標準クラスターの場合は、ModifyDBClusterDescription を使用します。	pc-**************
DBClusterDescription	string	必須	クラスター名。クラスター名は次の要件を満たす必要があります。 `http://` または `https://` で始めることはできません。長さは 2～256 文字である必要があります。	pc-****************
ClientToken	string	任意	リクエストのべき等性を確保し、重複送信を防ぐために使用されるクライアントトークン。値はクライアントによって生成され、異なるリクエスト間で一意である必要があります。大文字と小文字が区別され、最大 64 文字の ASCII 文字を使用できます。	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエストの ID。	65D7ACE6-4A61-4B6E-B357-8CB24A******

例

成功レスポンス

JSONJSON

{
  "RequestId": "65D7ACE6-4A61-4B6E-B357-8CB24A******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidDBClusterDescription.Malformed	The specified parameter DBClusterDescription is not valid.	指定された DBClusterDescription パラメーターは無効です。
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	操作に失敗しました。指定されたクラスターインスタンス ID が存在しません。
404	InvalidDBClusterId.Malformed	The DBClusterId provided does not exist in our records.	指定された DBClusterId がレコードに存在しません。

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

変更履歴

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