Tair (Redis OSS-compatible) インスタンスの自動更新機能が有効化されているかどうかを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
kvstore:DescribeInstanceAutoRenewalAttribute |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するためのクライアントトークンです。クライアント側で値を生成できますが、異なるリクエスト間で一意である必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字を超えてはなりません。 |
ETnLKlblzczshOTUbOCz**** |
| RegionId |
string |
必須 |
インスタンスのリージョン ID です。 |
cn-hangzhou |
| DBInstanceId |
string |
任意 |
インスタンスの ID です。 説明
デフォルトでは、システムがすべてのインスタンスについて自動更新機能が有効化されているかをチェックします。 |
r-bp1zxszhcgatnx**** |
| PageSize |
integer |
任意 |
1 ページあたりに返されるエントリ数です。有効値: 30、50、100。 説明
デフォルト値は 30 です。 |
30 |
| PageNumber |
integer |
任意 |
返されるページのページ番号です。値は 0 より大きい整数である必要があります。デフォルト値は 1 です。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID です。 |
2B17D708-1D6D-49F3-B6D7-478371DD**** |
| PageNumber |
integer |
返されたページのページ番号です。 |
1 |
| PageRecordCount |
integer |
現在のページで返されたエントリ数です。 |
30 |
| TotalRecordCount |
integer |
返されたエントリの合計数です。 |
1 |
| Items |
object |
||
| Item |
array<object> |
インスタンスの自動更新情報の詳細です。 |
|
|
object |
|||
| Duration |
integer |
自動更新期間(単位:月)です。 |
1 |
| DBInstanceId |
string |
インスタンスの ID です。 |
r-bp1zxszhcgatnx**** |
| AutoRenew |
string |
自動更新機能が有効化されているかどうかを示します。有効値:
|
true |
| RegionId |
string |
インスタンスのリージョン ID です。 |
cn-shanghai |
例
成功レスポンス
JSONJSON
{
"RequestId": "2B17D708-1D6D-49F3-B6D7-478371DD****",
"PageNumber": 1,
"PageRecordCount": 30,
"TotalRecordCount": 1,
"Items": {
"Item": [
{
"Duration": 1,
"DBInstanceId": "r-bp1zxszhcgatnx****",
"AutoRenew": "true",
"RegionId": "cn-shanghai"
}
]
}
}
エラーレスポンス
JSONJSON
{
"Items": {
"Item": [
{
"Duration": 1,
"RegionId": "cn-shanghai",
"DBInstanceId": "r-xxxxxxxxxxxxxxx",
"AutoRenew": "true"
}
]
},
"TotalRecordCount": 1,
"PageNumber": 1,
"RequestId": "2B17D708-1D6D-49F3-B6D7-478371DDDBE8",
"PageRecordCount": 1
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParameter | Specified parameter exceeds range. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。