API によるスケーリング前の利用可能なインスタンススペックのクエリ方法 - CADT

スペックアップまたはスペックダウンのための仕様のリストをクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bpstudio:QueryInstanceSpec4Modify

get

*Application

acs:bpstudio::{#accountId}:application/{#ApplicationId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApplicationId	string	必須	Cloud Architect Design Tools アプリケーションの ID。	BE68D71ZY5YYIU9R
InstanceId	string	必須	スペックアップまたはスペックダウンするリソースの ID。	rm-uf66k9143r2ch*****
MethodName	string	任意	対応するプロダクトの API 操作名。 Elastic Compute Service (ECS) インスタンスの仕様をクエリするには、`describeResourcesModification` を入力します。 ApsaraDB RDS インスタンスの仕様をクエリするには、`listAvailableClasses` を入力します。 ApsaraDB for Redis インスタンスの仕様をクエリするには、`getKvstoreInstanceClass` を入力します。 ApsaraDB for Redis インスタンスのシャード数をクエリするには、`getKvstoreShardNum` を入力します。サブスクリプション ApsaraDB for Redis インスタンスの仕様をクエリするには、`getShardClass` を入力します。サブスクリプション ApsaraDB for Redis インスタンスのディスク容量をクエリするには、`getStorage` を入力します。サブスクリプション ApsaraDB for Redis インスタンスのシャード数をクエリするには、`getShardQuantity` を入力します。 Tair インスタンスの仕様をクエリするには、`getShardClass` を入力します。 Tair インスタンスのシャード数をクエリするには、`getShardQuantity` を入力します。 Kafka インスタンスのインターネットトラフィックをクエリするには、`getEipMax` を入力します。 Kafka インスタンスのトラフィック仕様をクエリするには、`getIoMax` を入力します。 Kafka インスタンスのパーティション数をクエリするには、`getPartitionNum` を入力します。 Kafka インスタンスのディスク容量をクエリするには、`getDiskSize` を入力します。 PolarDB クラスターのノード仕様をクエリするには、`getMasterSpec` を入力します。 Elasticsearch クラスターのデータノード仕様をクエリするには、`getNodeSpec` を入力します。 Elasticsearch クラスターの Kibana ノード仕様をクエリするには、`getKibanaNodeSpecList` を入力します。 Elasticsearch クラスターの専用 Master ノード仕様をクエリするには、`getMasterSpecList` を入力します。 Elasticsearch クラスターのウォームデータノード仕様をクエリするには、`getWarmNodeSpecList` を入力します。 Elasticsearch クラスターのクライアントノード仕様をクエリするには、`getClientNodeSpecList` を入力します。 Elasticsearch クラスターの弾性データノード仕様をクエリするには、`getElasticNodeSpecList` を入力します。 Lindorm インスタンスの試用版 LindormTSDB、検索エンジン、LTL エンジン、またはベクトルエンジンの仕様をクエリするには、`getLightNodeSpec` を入力します。 Lindorm インスタンスのプロダクション検索エンジンの仕様をクエリするには、`getBasicSearchNodeSpec` を入力します。 Lindorm インスタンスのプロダクションベクトルエンジンの仕様をクエリするには、`getBasicVectorNodeSpec` を入力します。 Lindorm インスタンスのプロダクション LindormTable の仕様をクエリするには、`getBasicWideTableNodeSpec` を入力します。 SLB インスタンスのインスタンスタイプをクエリするには、`getSlbLoadBalancerSpec` を入力します。 Hbase インスタンスの仕様をクエリするには、`getHbaseCoreSpec` を入力します。 ApsaraDB for MongoDB インスタンスの仕様をクエリするには、`getDdsClass` を入力します。 Message Queue for Apache RocketMQ インスタンスのピーク TPS をクエリするには、`getOnsPreTpsMax` を入力します。 Message Queue for Apache RocketMQ インスタンスの最大 Topic 数をクエリするには、`getOnsPreTopicCapacity` を入力します。 Message Queue for Apache RocketMQ インスタンスのログブローカー容量をクエリするには、`getOnsPreMessageCapacity` を入力します。 Lindorm インスタンスのワイドテーブル仕様をクエリするには、`getHitsdbLindormCoreSpec` を入力します。 DRDS インスタンスのインスタンスタイプをクエリするには、`getDrdsInstanceSpec` を入力します。 ClickHouse Compute Units (CCU) の最大数をクエリするには、`getClickHouseMaxCcu` を入力します。 CCU の最小数をクエリするには、`getClickHouseMinCcu` を入力します。 Zookeeper 仕様をクエリするには、`getClickHouseZkSize` を入力します。仕様をクエリするには、`getClickHouseInstanceClass` を入力します。ストレージクラスをクエリするには、`getClickHouseStorageType` を入力します。ストレージ領域をクエリするには、`getClickHouseStorageSize` を入力します。 PolarDB-X 1.0 インスタンスのノード仕様をクエリするには、`getDrdsPolarxNodeSpec` を入力します。 PolarDB-X 1.0 インスタンスのコンピュートノード仕様をクエリするには、`getDrdsPolarxCnNodeSpec` を入力します。 PolarDB-X 1.0 インスタンスのデータノード仕様をクエリするには、`getDrdsPolarxDnNodeSpec` を入力します。 PolarDB-X 1.0 インスタンスのデータノードのディスク領域をクエリするには、`getDrdsPolarxDnStorageSpace` を入力します。 OpenSearch インスタンスのクラスタープリファレンスをクエリするには、`getOpenSearchBuyType` を入力します。 OpenSearch インスタンスのストレージ容量をクエリするには、`getOpenSearchStorage` を入力します。 OpenSearch インスタンスのコンピューティングリソースをクエリするには、`getOpenSearchCompute` を入力します。	describeResourcesModification
Parameters	object	任意	仕様に関する制約。
	any	任意	パラメーター。説明サブスクリプションインスタンスの場合、スペックアップには `UPGRADE` を使用し、スペックダウンには `DOWNGRADE` を使用します。従量課金インスタンスの場合、構成変更を示すため、スペックアップとスペックダウンの両方に `UPGRADE` を使用します。 ECS インスタンス変更の仕様をクエリするには: orderType:UPGRADE ApsaraDB RDS インスタンス変更の仕様をクエリするには: orderType:UPGRADE ApsaraDB for Redis インスタンス変更の仕様をクエリするには: orderType:UPGRADE サブスクリプション ApsaraDB for Redis インスタンス変更の仕様をクエリするには: orderType:UPGRADE サブスクリプション ApsaraDB for Redis インスタンス変更の仕様に対応するディスク容量をクエリするには: orderType:UPGRADE shard_class:xxx Tair インスタンス変更の仕様をクエリするには: orderType:UPGRADE Lindorm インスタンス変更のプロパティをクエリするには: orderType:UPGRADE SLB インスタンス変更の仕様をクエリするには: orderType:UPGRADE Hbase インスタンス変更のコア仕様をクエリするには: orderType:UPGRADE ApsaraDB for MongoDB インスタンス変更の仕様をクエリするには: orderType:UPGRADE Message Queue for Apache RocketMQ Platinum Edition インスタンスのスペックアップまたはスペックダウンの仕様をクエリするには: orderType:UPGRADE Message Queue for Apache RocketMQ の Standard Edition インスタンスを Platinum Edition インスタンスにスペックアップする仕様をクエリするには: orderType:BUY Lindorm インスタンス変更の仕様をクエリするには: orderType:UPGRADE DRDS インスタンス変更の仕様をクエリするには: orderType:UPGRADE	orderType:UPGRADE

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
Success	boolean	リクエストが成功したかどうかを示します。	true
Code	string	リターンコード。	200
Message	string	エラーメッセージ。	Success
Data	object	クエリ結果。
OptionalValues	array<object>	変更に利用可能な仕様のリスト。
	object
Label	string	仕様の名前。	1 GB
Value	string	仕様の値。	redis.shard.small.2.ce
Min	number	最小値。このパラメーターは、ApsaraDB for Redis インスタンスのシャード数をクエリする場合に有効です。	1
Max	number	最大値。このパラメーターは、ApsaraDB for Redis インスタンスのシャード数をクエリする場合に有効です。	1
Step	number	ステップサイズ。このパラメーターは、ApsaraDB for Redis インスタンスのシャード数をクエリする場合に有効です。	1
RequestId	string	リクエスト ID。	847C9D0A-BABD-589C-8A9C-6464409EDED9
AccessDeniedDetail	string	アクセス拒否に関する詳細。	{ "PolicyType": "", "AuthPrincipalOwnerId": "", "EncodedDiagnosticMessage": "", "AuthPrincipalType": "", "AuthPrincipalDisplayName": "", "NoPermissionType": "", "AuthAction": "" }

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "Code": "200",
  "Message": "Success",
  "Data": {
    "OptionalValues": [
      {
        "Label": "1  GB",
        "Value": "redis.shard.small.2.ce",
        "Min": 1,
        "Max": 1,
        "Step": 1
      }
    ]
  },
  "RequestId": "847C9D0A-BABD-589C-8A9C-6464409EDED9",
  "AccessDeniedDetail": "{\n    \"PolicyType\": \"\",\n    \"AuthPrincipalOwnerId\": \"\",\n    \"EncodedDiagnosticMessage\": \"\",\n    \"AuthPrincipalType\": \"\",\n    \"AuthPrincipalDisplayName\": \"\",\n    \"NoPermissionType\": \"\",\n    \"AuthAction\": \"\"\n  }"
}

エラーコード

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

変更履歴

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