調用DescribeInstanceAttribute查詢實例詳細的屬性信息,例如:實例ID、實例的備注信息。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeInstanceAttribute | 系統規定參數。取值:DescribeInstanceAttribute。 |
InstanceId | String | 是 | dbaudit-cn-78v1gc**** | 審計的實例ID。 可以通過調用DescribeInstances接口獲取的審計實例列表獲取實例ID。 |
RegionId | String | 否 | cn-hangzhou | 數據庫審計實例的地域ID。 可以通過調用DescribeRegions接口獲取地域ID。 |
Lang | String | 否 | zh | 請求和接收消息的語言類型,默認值zh。取值:
|
調用API時,除了本文中該API的請求參數,還需加入阿里云API公共請求參數。公共請求參數的詳細介紹,請參見公共參數。
調用API的請求格式,請參見本文示例中的請求示例。
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 28382024-466D-4641-A144-40FD0DD53766 | 本次請求的ID。 |
InstanceAttribute | Object | 實例屬性信息。 |
|
VpcId | String | vpc-bp1c85tzgqu1bf5b**** | 實例綁定的VPC ID。 |
VswitchId | String | vsw-bp1kep1f0k5fnyfs**** | 實例綁定的交換機ID。 |
ExpireTime | Long | 1578067200000 | 實例的過期時間。 單位:毫秒。 |
InstanceId | String | dbaudit-cn-78v1gc**** | 本次請求的實例ID。 |
InternetEndpoint | String | tsiqvqjjlq-public.dbaudit.aliyuncs.com | 實例的公網域名。 |
RegionId | String | cn-hangzhou | 地域ID。 |
IntranetEndpoint | String | tsiqvqjjlq.dbaudit.aliyuncs.com | 實例的私網域名。 |
StartTime | Long | 1577437765000 | 實例的開始時間。 用時間戳表示,即購買實例的時間。單位:毫秒。 |
SeriesCode | String | alpha | 購買實例時的系列Code。 |
Description | String | API | 實例的備注信息。 |
InstanceStatus | String | RUNNING | 實例狀態。取值:
|
LicenseCode | String | alpha.professional | 實例的套餐Code。 用戶購買實例時選擇的套餐對應的Code。 |
PublicNetworkAccess | Boolean | true | 是否可以通過公網訪問該審計實例。取值:
|
WhiteList | Array of String | ["10.168.XX.XX/32"] | 允許訪問數據庫審計實例的公網IP。 |
示例
請求示例
http(s)://[Endpoint]/?Action=DescribeInstanceAttribute
&InstanceId=dbaudit-cn-78v1gc****
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstanceAttributeResponse>
<RequestId>28382024-466D-4641-A144-40FD0DD53766</RequestId>
<InstanceAttribute>
<VpcId>vpc-bp1c85tzgqu1bf5b****</VpcId>
<VswitchId>vsw-bp1kep1f0k5fnyfs****</VswitchId>
<ExpireTime>1578067200000</ExpireTime>
<InstanceId>dbaudit-cn-78v1gc****</InstanceId>
<InternetEndpoint>tsiqvqjjlq-public.dbaudit.aliyuncs.com</InternetEndpoint>
<RegionId>cn-hangzhou</RegionId>
<IntranetEndpoint>tsiqvqjjlq.dbaudit.aliyuncs.com</IntranetEndpoint>
<StartTime>1577437765000</StartTime>
<SeriesCode>alpha</SeriesCode>
<Description>API</Description>
<InstanceStatus>RUNNING</InstanceStatus>
<LicenseCode>alpha.professional</LicenseCode>
<PublicNetworkAccess>true</PublicNetworkAccess>
<WhiteList>["10.168.XX.XX/32"]</WhiteList>
</InstanceAttribute>
</DescribeInstanceAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "28382024-466D-4641-A144-40FD0DD53766",
"InstanceAttribute" : {
"VpcId" : "vpc-bp1c85tzgqu1bf5b****",
"VswitchId" : "vsw-bp1kep1f0k5fnyfs****",
"ExpireTime" : 1578067200000,
"InstanceId" : "dbaudit-cn-78v1gc****",
"InternetEndpoint" : "tsiqvqjjlq-public.dbaudit.aliyuncs.com",
"RegionId" : "cn-hangzhou",
"IntranetEndpoint" : "tsiqvqjjlq.dbaudit.aliyuncs.com",
"StartTime" : 1577437765000,
"SeriesCode" : "alpha",
"Description" : "API",
"InstanceStatus" : "RUNNING",
"LicenseCode" : "alpha.professional",
"PublicNetworkAccess" : true,
"WhiteList" : [ "[\"10.168.XX.XX/32\"]" ]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?