7.9. シャードキーの取得¶

GET /1/(tenantId)/buckets/object/(bucketName)/shardkey¶

オブジェクトバケットのインデックス一覧情報を取得する。

Request Headers:
	X-Application-Id -- アプリケーションID(必須) X-Application-Key -- アプリケーションキー(必須) X-Session-Token -- セッショントークン(オプション)
Parameters:	bucketName (string) -- バケット名
Status Codes:	200 OK -- 正常に取得した 400 Bad Request -- パラメータ不正。DBがシャード構成ではない。 401 Unauthorized -- 認証エラー 403 Forbidden -- 権限エラー 404 Not Found -- 指定したバケットが存在しない
Response JSON Object:
	key (string) -- シャードキーの配列 unique (boolean) -- ユニーク制約

レスポンスボディの例

{
    "key": [
        { "name": "key1", "type": 1 }
    ],
    "unique": false
}

この例は、key1 の昇順でシャードキーが設定されており、ユニーク制約は設定されていないことを示す。

注意事項