インスタンス情報を照会します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /v2/openapi/getinstance HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceName |
string |
必須 |
インスタンスの名前。 |
instance-test |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返される構造体。 |
||
| RequestId |
string |
リクエスト ID。問題のトラブルシューティングに使用できます。 |
757E172A-F94B-5E78-8A23-D9068E42F2E9 |
| InstanceName |
string |
インスタンスの名前。 |
instance-test |
| ResourceGroupId |
string |
インスタンスが属するリソースグループの ID。 |
rg-acfmxh4em5jncda |
| RegionId |
string |
インスタンスのリージョン ID。 |
cn-chengdu |
| SPInstanceId |
string |
インスタンスの ID。 |
ots_standard_public_cn-9lb34u7u5001 |
| AliasName |
string |
インスタンスのエイリアス。 |
instance-test |
| UserId |
string |
ユーザー ID。 |
16542312566 |
| Network |
string |
インスタンスのネットワークタイプ。有効な値：
|
VPC |
| InstanceDescription |
string |
インスタンスの説明。 |
Description of the test instance. |
| InstanceSpecification |
string |
インスタンスのタイプ。
|
SSD |
| PaymentType |
string |
課金方法。有効な値：
|
Subscription |
| StorageType |
string |
ストレージタイプ。
|
HYBRID |
| VCUQuota |
integer |
VCU クォータ。 |
20 |
| TableQuota |
integer |
インスタンス内のテーブルの総数。 |
100 |
| InstanceStatus |
string |
インスタンスのステータス。
|
normal |
| CreateTime |
string |
インスタンスが作成された時刻。 |
2019-12-23T07:24:33Z |
| Tags |
array<object> |
インスタンスのタグ。 |
|
|
object |
インスタンスのタグ。 |
||
| Key |
string |
タグキー。 |
tag |
| Value |
string |
タグ値。 |
333 |
| TagKey |
string |
(非推奨) タグキー。 |
keyTestA |
| TagValue |
string |
(非推奨) タグ値。 |
00004a20240452b0 |
| NetworkTypeACL |
array |
アクセスが許可されているネットワークのタイプ。有効な値：
|
|
|
string |
アクセスが許可されているネットワークのタイプ。 |
INTERNET |
|
| NetworkSourceACL |
array |
アクセスが許可されているネットワークのソース。有効な値： TRUST_PROXY：コンソール |
|
|
string |
アクセスが許可されているネットワークのソース。 |
TRUST_PROXY |
|
| Policy |
string |
インスタンスポリシー。 |
{ "Version": "1", "Statement": [ { "Action": [ "ots:*" ], "Resource": [ "acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*" ], "Principal": [ "*" ], "Effect": "Allow", "Condition": { "StringEquals": { "ots:TLSVersion": [ "1.2" ] }, "IpAddress": { "acs:SourceIp": [ "192.168.0.1", "198.51.100.1" ] } } } ] } |
| PolicyVersion |
integer |
インスタンスポリシーのバージョン。 |
1 |
| IsMultiAZ |
boolean |
インスタンスに対してゾーン冗長ストレージ (ZRS) が有効になっているかどうかを示します。
|
true |
| ElasticVCUUpperLimit |
number |
インスタンスの VCU の上限。 |
6 |
例
成功レスポンス
JSONJSON
{
"RequestId": "757E172A-F94B-5E78-8A23-D9068E42F2E9",
"InstanceName": "instance-test",
"ResourceGroupId": "rg-acfmxh4em5jncda",
"RegionId": "cn-chengdu",
"SPInstanceId": "ots_standard_public_cn-9lb34u7u5001",
"AliasName": "instance-test",
"UserId": "16542312566",
"Network": "VPC",
"InstanceDescription": "Description of the test instance.",
"InstanceSpecification": "SSD",
"PaymentType": "Subscription",
"StorageType": "HYBRID",
"VCUQuota": 20,
"TableQuota": 100,
"InstanceStatus": "normal",
"CreateTime": "2019-12-23T07:24:33Z",
"Tags": [
{
"Key": "tag",
"Value": "333",
"TagKey": "keyTestA",
"TagValue": "00004a20240452b0"
}
],
"NetworkTypeACL": [
"INTERNET"
],
"NetworkSourceACL": [
"TRUST_PROXY"
],
"Policy": "{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Action\": [\n \"ots:*\"\n ],\n \"Resource\": [\n \"acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*\"\n ],\n \"Principal\": [\n \"*\"\n ],\n \"Effect\": \"Allow\",\n \"Condition\": {\n \"StringEquals\": {\n \"ots:TLSVersion\": [\n \"1.2\"\n ]\n },\n \"IpAddress\": {\n \"acs:SourceIp\": [\n \"192.168.0.1\",\n \"198.51.100.1\"\n ]\n }\n }\n }\n ]\n}",
"PolicyVersion": 1,
"IsMultiAZ": true,
"ElasticVCUUpperLimit": 6
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。