DescribeDcdnKvNamespace API リファレンス - Edge Security Acceleration

名前空間について説明します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dcdn:DescribeDcdnKvNamespace

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Namespace	string	必須	名前空間の名前です。	ns1

レスポンスフィールド

フィールド	型	説明	例
	object
Status	string	名前空間のステータス。有効な値: online: 通常。 delete: 削除保留中。 deleting: 削除中。 deleted: 削除済み。	online
Namespace	string	名前空間の名前です。	ns1
NamespaceId	string	名前空間 ID です。	12423131231****
RequestId	string	リクエスト ID です。	D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C
Description	string	名前空間の説明です。	the first namespace
CapacityString	string	名前空間の利用可能な容量です。	1 GB
CapacityUsedString	string	名前空間の使用済み容量です。	100 MB
Mode	string	モードです。通常モード: デフォルトのモードです。エッジノードでキーと値 (KV) のペアが見つからない場合、ノードは中央データセンターに KV ペアを照会して、グローバルなデータ整合性を確保します。高速モード: エッジノードで KV ペアが見つからない場合、ノードは中央データセンターに照会せずに「キーが見つかりません」というメッセージを返します。このモードは KV クエリのパフォーマンスを向上させますが、KV クエリのヒット率が低下する可能性があります。このモードを有効にするには、チケットを送信してください。	Normal
Capacity	integer	名前空間の利用可能な容量 (バイト単位) です。	1073741824
CapacityUsed	integer	名前空間の使用済み容量 (バイト単位) です。	10048576

例

成功レスポンス

JSONJSON

{
  "Status": "online",
  "Namespace": "ns1",
  "NamespaceId": "12423131231****",
  "RequestId": "D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C",
  "Description": "the first namespace",
  "CapacityString": "1 GB",
  "CapacityUsedString": "100 MB",
  "Mode": "Normal",
  "Capacity": 1073741824,
  "CapacityUsed": 10048576
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.Parameter	The specified parameter is invalid.
400	InvalidAccount.Malformed	The specified account is invalid.
400	InvalidNameSpace.Malformed	The specified namespace is invalid.
400	InvalidKey.Malformed	The specified key is invalid.
400	InvalidKey.ExceedsMaximum	The size of the key cannot exceed 512 bytes.
400	InvalidValue.ExceedsMaximum	The size of the value cannot exceed 2,000,000 bytes.
403	InvalidKey.ExceedsCapacity	The maximum capacity of a single namespace cannot exceed 1 GB.
403	Unauthorized.InvalidParameters	The specified authentication parameters are invalid.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.
403	Unauthorized.InvalidToken	Token authentication failed.
403	Unauthorized.InvalidResource	Resource authentication failed.
404	InvalidAccount.NotFound	The specified account does not exist.
404	InvalidNameSpace.NotFound	The specified namespace does not exist.
404	InvalidKey.NotFound	The specified key does not exist.
406	InvalidNameSpace.Duplicate	The specified namespace already exists.
406	InvalidNameSpace.QuotaFull	The maximum number of namespaces is exceeded.
406	InvalidKey.QuotaFull	The maximum number of keys is exceeded.
429	TooManyRequests	Too many requests are submitted.
429	TooQuickRequests	Request for putting or deleting keys are frequently submitted.

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

変更履歴

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