forked from docs/doc-exports
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com> Co-authored-by: chenjunjie <chenjunjie@huawei.com> Co-committed-by: chenjunjie <chenjunjie@huawei.com>
1091 lines
43 KiB
HTML
1091 lines
43 KiB
HTML
<a name="ShowInstance"></a><a name="ShowInstance"></a>
|
||
|
||
<h1 class="topictitle1">Querying an Instance</h1>
|
||
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the details about a specified instance.</p>
|
||
</div>
|
||
<div class="section" id="ShowInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}</p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p><strong>Definition</strong></p>
|
||
<p>Project ID. For details about how to obtain it, see <a href="hrm-api-0011.html">Obtaining a Project ID</a>.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>instance_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p><strong>Definition</strong></p>
|
||
<p>Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
|
||
</div>
|
||
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstance__response_ShowInstanceResp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Instance name.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>engine</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Message engine type.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>rocketmq</strong>: RocketMQ message engine.</p>
|
||
</li><li><p><strong>reliability</strong>: RocketMQ message engine alias.</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Message status.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>For details, see <a href="hrm-api-0010.html">Instance Status</a>.</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>description</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Message description.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Message description.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>single.basic</strong>: 5.x single-node basic edition.</p>
|
||
</li><li><p><strong>cluster.basic</strong>: 5.x cluster basic edition</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>specification</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Instance specification.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>engine_version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Instance version.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>5.x</strong></p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>instance_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Instance ID.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>charging_mode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Billing mode.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p><strong>1</strong> indicates pay-per-use.</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>vpc_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>VPC ID.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>vpc_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>VPC name.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>created_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Time when creation is complete.</p>
|
||
<p>The time is in the format of timestamp, that is, the offset milliseconds from 1970-01-01 00:00:00 UTC to the specified time.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>product_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>RocketMQ instance flavors.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>If <strong>type</strong> is <strong>single.basic</strong>, select single-node flavors. If <strong>type</strong> is <strong>cluster.basic</strong>, select cluster flavors.</p>
|
||
<ul><li><p><strong>rocketmq.b1.large.1</strong>: RocketMQ 5.x basic edition single-node flavor, instance TPS 500</p>
|
||
</li><li><p><strong>rocketmq.b2.large.4</strong>: RocketMQ 5.x basic edition cluster flavor, instance TPS 2,000</p>
|
||
</li><li><p><strong>rocketmq.b2.large.8</strong>: RocketMQ 5.x basic edition cluster flavor, instance TPS 4,000</p>
|
||
</li><li><p><strong>rocketmq.b2.large.12</strong>: RocketMQ 5.x basic edition cluster flavor, instance TPS 6,000</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>security_group_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Security group ID.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>security_group_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Security group name.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>subnet_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Subnet ID.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>subnet_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Subnet name.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>subnet_cidr</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Subnet route.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>available_zones</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of strings</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>List of AZ IDs.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>available_zone_names</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of strings</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>List of AZ names.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>user_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>User ID.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>user_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Username.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>maintain_begin</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Time at which the maintenance window starts. The format is <em>HH:mm:ss</em>.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>maintain_end</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Time at which the maintenance window ends. The format is <em>HH:mm:ss</em>.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>storage_space</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Storage space, in GB.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>Different instance specifications support different storage configurations.</p>
|
||
<ul><li><p>RocketMQ 5.x single-node storage range: 100–30000</p>
|
||
</li><li><p>RocketMQ 5.x cluster storage range: 200–60000</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>used_storage_space</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Used message storage space, in GB.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>Different instance specifications support different storage configurations.</p>
|
||
<ul><li><p>RocketMQ 5.x single-node storage range: 100–30000</p>
|
||
</li><li><p>RocketMQ 5.x cluster storage range: 200–60000</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>enable_publicip</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether to enable public access.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>publicip_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>ID of the EIP bound to the instance.</p>
|
||
<p>Use commas (,) to separate multiple EIP IDs.</p>
|
||
<p>This parameter is mandatory if public access is enabled (that is, <strong>enable_publicip</strong> is set to <strong>true</strong>).</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>publicip_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Public IP address.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>ssl_enable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether SSL is enabled.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>cross_vpc_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Cross-VPC access information.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>storage_resource_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Storage resource ID.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>storage_spec_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Storage specification code.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>dms.physical.storage.high.v2</strong>: high I/O disk</p>
|
||
</li><li><p><strong>dms.physical.storage.ultra.v2</strong>: ultra-high I/O disk</p>
|
||
</li><li><p><strong>dms.physical.storage.general</strong>: general-purpose SSD</p>
|
||
</li><li><p><strong>dms.physical.storage.extreme</strong>: extreme SSD</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>service_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Service type.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>advanced</strong>: Service type.</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>storage_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Storage type.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>hec</strong>: Storage type.</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>ipv6_enable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether IPv6 is enabled.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>disk_encrypted</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether disk encryption is enabled.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>enable_acl</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether to enable access control.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>broker_num</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Number of brokers.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>dns_enable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether to enable domain name access to an instance.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>namesrv_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Metadata address.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>namesrv_domain_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Metadata domain name.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>broker_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Service data address.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>public_namesrv_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Public network metadata address.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>public_namesrv_domain_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Public metadata domain name.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>public_broker_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Public network service data address.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>grpc_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>gRPC connection address (displayed only for RocketMQ 5.x).</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>grpc_domain_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>gRPC connection domain name (displayed only for RocketMQ 5.x).</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>public_grpc_address</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Public gRPC connection address (displayed only for RocketMQ 5.x).</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>public_grpc_domain_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Public gRPC domain name (displayed only for RocketMQ 5.x).</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>enterprise_project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Enterprise project ID.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowInstance__response_TagEntity">TagEntity</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Tag list.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>total_storage_space</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Total storage space.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>resource_spec_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Resource specification.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>produce_portion</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Production TPS proportion.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>consume_portion</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Consumption TPS proportion.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>dr_enable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether the instance has disaster recovery (DR).</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>config_ssl_need_restart_process</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether a restart is required to configure SSL.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>tls_mode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Security protocol used by an instance.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>arch_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Architecture type.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>X86</strong></p>
|
||
</li><li><p><strong>ARM</strong></p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>auto_volume_expand_enable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong></p>
|
||
<p>Whether to enable automatic disk capacity expansion.</p>
|
||
<p><strong>Constraints</strong></p>
|
||
<p>N/A</p>
|
||
<p><strong>Range</strong></p>
|
||
<ul><li><p><strong>true</strong>: Yes</p>
|
||
</li><li><p><strong>false</strong>: No</p>
|
||
</li></ul>
|
||
<p><strong>Default Value</strong></p>
|
||
<p>N/A</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowInstance__response_TagEntity"></a><a name="response_TagEntity"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowInstance__response_TagEntity" frame="border" border="1" rules="all"><caption><b>Table 3 </b>TagEntity</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag key.</p>
|
||
<ul><li><p>Must be specified.</p>
|
||
</li><li><p>Must be unique for the same instance.</p>
|
||
</li><li><p>Can contain 1 to 128 characters.</p>
|
||
</li><li><p>Can contain letters, digits, spaces, and special characters _.:=+-@</p>
|
||
</li><li><p>Cannot start or end with a space.</p>
|
||
</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag value.</p>
|
||
<ul><li><p>Can contain 0 to 255 characters.</p>
|
||
</li><li><p>Can contain letters, digits, spaces, and special characters _.:=+-@</p>
|
||
</li><li><p>Cannot start or end with a space.</p>
|
||
</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying details of a specified instance</p>
|
||
<pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}</pre>
|
||
</div>
|
||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
||
<p>Instance queried successfully.</p>
|
||
<pre class="screen">{
|
||
"name" : "reliability-test",
|
||
"engine" : "reliability",
|
||
"status" : "RUNNING",
|
||
"description" : "",
|
||
"type" : "cluster.basic",
|
||
"specification" : "rocketmq.b2.large.4, 2000 tps",
|
||
"engine_version" : "5.x",
|
||
"instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6",
|
||
"resource_spec_code" : "",
|
||
"charging_mode" : 1,
|
||
"vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf",
|
||
"vpc_name" : "vpc-1101840",
|
||
"created_at" : "1636699753874",
|
||
"product_id" : "rocketmq.b2.large.4",
|
||
"security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c",
|
||
"security_group_name" : "Sys-default",
|
||
"subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50",
|
||
"subnet_name" : "subnet-boce",
|
||
"subnet_cidr" : "192.168.64.0/18",
|
||
"available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
|
||
"available_zone_names" : [ "AZ3" ],
|
||
"user_id" : "0b01fbb53600d4671fa8c00673c71260",
|
||
"user_name" : "",
|
||
"maintain_begin" : "02:00:00",
|
||
"maintain_end" : "06:00:00",
|
||
"dns_enable" : false,
|
||
"storage_space" : 558,
|
||
"total_storage_space" : 1200,
|
||
"used_storage_space" : 28,
|
||
"enable_publicip" : true,
|
||
"publicip_id" : "7e6b7beb-ef13-4805-878d-285890b17a12,87827295-84e1-4118-9ab3-a90dd8c9dace,91306a18-5781-4529-b739-5aeec10ec4e6,a68e8f0e-a24f-4521-910e-39696a56fcdf,bb1cd147-a7af-46ca-9548-99fec4034ba2",
|
||
"publicip_address" : "***",
|
||
"ssl_enable" : false,
|
||
"cross_vpc_info" : "{\"192.168.1.21\":{\"advertised_ip\":\"192.168.1.21\",\"broker_port\":\"-\",\"port_id\":\"fa020857-d899-497c-a5f8-8dd90ed67ff7\",\"namesrv_port\":\"8301\"},\"192.168.1.246\":{\"advertised_ip\":\"192.168.1.246\",\"broker_port\":\"10100\",\"port_id\":\"c0f0586f-a4ee-41b5-a7f1-b4e554bbf12d\",\"namesrv_port\":\"-\"},\"192.168.1.77\":{\"advertised_ip\":\"192.168.1.77\",\"broker_port\":\"10101\",\"port_id\":\"8eb1d144-4315-402f-8498-37c9a10b630c\",\"namesrv_port\":\"-\"},\"192.168.1.159\":{\"advertised_ip\":\"192.168.1.159\",\"broker_port\":\"-\",\"port_id\":\"d35b22af-a202-4329-bda4-26e1bdf2aa8e\",\"namesrv_port\":\"8300\"},\"192.168.1.14\":{\"advertised_ip\":\"192.168.1.14\",\"broker_port\":\"10102\",\"port_id\":\"5fcb50fd-3af5-4123-a455-a67f1b926026\",\"namesrv_port\":\"-\"}}",
|
||
"storage_resource_id" : "164bdaef-2e67-4fd5-be8b-a18f91d455a2",
|
||
"storage_spec_code" : "dms.physical.storage.ultra.v2",
|
||
"service_type" : "advanced",
|
||
"storage_type" : "hec",
|
||
"disk_encrypted" : false,
|
||
"enable_acl" : false,
|
||
"dr_enable" : false,
|
||
"config_ssl_need_restart_process" : false,
|
||
"broker_num" : 1,
|
||
"namesrv_address" : "***",
|
||
"broker_address" : "***",
|
||
"public_namesrv_address" : "***",
|
||
"public_broker_address" : "***",
|
||
"grpc_address" : "***",
|
||
"public_grpc_address" : "***"
|
||
}</pre>
|
||
</div>
|
||
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstance__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Instance queried successfully.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Lifecycle Management</a></div>
|
||
</div>
|
||
</div>
|
||
|