Queries information about the configuration of an instance.

Request parameters

Parameter Type Required Example Description
Action String Yes ListInstanceServiceConfigurations

The operation that you want to perform. Set the value to ListInstanceServiceConfigurations.

ClusterId String Yes hb-t4naqsay5gn****

The ID of the instance.

PageSize Integer Yes 1

The number of the page to return. Default value: 1.

PageNumber Integer No 10

The number of entries to return on each page. Default value: 10.

Response parameters

Parameter Type Example Description
ConfigureList Array of Config

The configuration items.

Config
ConfigureName String hbase#hbase-site.xml#hbase.client.keyvalue.maxsize

The name of the configuration item.

ConfigureUnit String INT

The data type of the configuration item.

  • INT: The value of the configuration item is an integer.
  • STR: The value of the configuration item is a string.
  • FLOAT: The value of the configuration item is of the FLOAT data type.
DefaultValue String 10485760

The default value of the configuration item.

Description String hbase client keyvalue maxsize

The description of the configuration item.

NeedRestart String true

Indicates whether the system restarts the instance after the value of the configuration item is changed.

  • true: The system restarts the instance.
  • false: The system does not restart the instance.
RunningValue String 10485760

The current value of the configuration item.

ValueRange String R[10485760,52428800]

The range of valid values.

PageNumber Integer 1

The page number of the returned page.

PageRecordCount Integer 10

The number of entries returned per page.

RequestId String 5B381E36-BCA3-4377-8638-B65C236617D5

The ID of the request.

TotalRecordCount Long 42

The total number of entries that are obtained.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListInstanceServiceConfigurations
&ClusterId=hb-t4naqsay5gn****
&PageSize=1
&<Common request parameters>

Sample responses

XML format 

<TotalRecordCount>42</TotalRecordCount>
<PageRecordCount>10</PageRecordCount>
<RequestId>1DD84F22-4615-451E-8F05-58405EDB7236</RequestId>
<PageNumber>1</PageNumber>
<ConfigureList>
    <Config>
        <ValueRange>R[10485760,52428800]</ValueRange>
        <DefaultValue>10485760</DefaultValue>
        <Description>hbase client keyvalue maxsize</Description>
        <ConfigureUnit>INT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.client.keyvalue.maxsize</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>10485760</RunningValue>
    </Config>
    <Config>
        <ValueRange>G[true|false]</ValueRange>
        <DefaultValue>false</DefaultValue>
        <Description>Enable dynamic class loader</Description>
        <ConfigureUnit>STR</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.dynamic.jars.enabled</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>false</RunningValue>
    </Config>
    <Config>
        <ValueRange>G[.+]</ValueRange>
        <DefaultValue>true</DefaultValue>
        <ConfigureUnit>STR</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.exporter.enabled</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>true</RunningValue>
    </Config>
    <Config>
        <ValueRange>R[0,604800000]</ValueRange>
        <DefaultValue>604800000</DefaultValue>
        <Description>The time (in miliseconds) between major compactions of all HStoreFiles in a region</Description>
        <ConfigureUnit>INT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.hregion.majorcompaction</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>604800000</RunningValue>
    </Config>
    <Config>
        <ValueRange>R[0.0,0.7]</ValueRange>
        <DefaultValue>0.0</DefaultValue>
        <Description>Split the call queues into read and write queues. The specified interval (which should be between 0.0 and 1.0) will be multiplied by the number of call queues. A value of 0 indicate to not split the call queues, meaning that both read and write requests will be pushed to the same set of queues.</Description>
        <ConfigureUnit>FLOAT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.ipc.server.callqueue.read.ratio</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>0.0</RunningValue>
    </Config>
    <Config>
        <ValueRange>R[0.0,0.7]</ValueRange>
        <DefaultValue>0.0</DefaultValue>
        <Description>Given the number of read call queues, calculated from the total number of call queues multiplied by the callqueue.read.ratio, the scan.ratio property will split the read call queues into small-read and long-read queues.</Description>
        <ConfigureUnit>FLOAT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.ipc.server.callqueue.scan.ratio</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>0.0</RunningValue>
    </Config>
    <Config>
        <ValueRange>R[0.24,0.475]|E[0.8*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}&lt;=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]|E[0.95*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}&gt;=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]</ValueRange>
        <DefaultValue>0.3</DefaultValue>
        <Description>Maximum size of all memstores in a region server before flushes are forced. Defaults to 95% of hbase.regionserver.global.memstore.size (0.95).</Description>
        <ConfigureUnit>FLOAT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>0.3</RunningValue>
    </Config>
    <Config>
        <ValueRange>R[0.3,0.5]|E[${hbase#hbase-site.xml#hfile.block.cache.size}+${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}&lt;=0.8]</ValueRange>
        <DefaultValue>0.35</DefaultValue>
        <Description>Maximum size of all memstores in a region server before new updates are blocked and flushes are forced</Description>
        <ConfigureUnit>FLOAT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.global.memstore.size</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>0.35</RunningValue>
    </Config>
    <Config>
        <ValueRange>R[16,256]</ValueRange>
        <DefaultValue>32</DefaultValue>
        <Description>If more than this many logs, force flush of oldest region to oldest edit goes to disk.</Description>
        <ConfigureUnit>INT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.maxlogs</ConfigureName>
        <NeedRestart>true</NeedRestart>
        <RunningValue>32</RunningValue>
    </Config>
    <Config>
        <ValueRange>R[1,10]</ValueRange>
        <DefaultValue>1</DefaultValue>
        <Description>Large compaction threads</Description>
        <ConfigureUnit>INT</ConfigureUnit>
        <ConfigureName>hbase#hbase-site.xml#hbase.regionserver.thread.compaction.large</ConfigureName>
        <NeedRestart>false</NeedRestart>
        <RunningValue>1</RunningValue>
    </Config>
</ConfigureList>

JSON format 

{
  "TotalRecordCount": 42,
  "PageRecordCount": 10,
  "RequestId": "1DD84F22-4615-451E-8F05-58405EDB7236",
  "PageNumber": 1,
  "ConfigureList": {
    "Config": [
      {
        "ValueRange": "R[10485760,52428800]",
        "DefaultValue": "10485760",
        "Description": "hbase client keyvalue maxsize",
        "ConfigureUnit": "INT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.client.keyvalue.maxsize",
        "NeedRestart": "true",
        "RunningValue": "10485760"
      },
      {
        "ValueRange": "G[true|false]",
        "DefaultValue": "false",
        "Description": "Enable dynamic class loader",
        "ConfigureUnit": "STR",
        "ConfigureName": "hbase#hbase-site.xml#hbase.dynamic.jars.enabled",
        "NeedRestart": "true",
        "RunningValue": "false"
      },
      {
        "ValueRange": "G[.+]",
        "DefaultValue": "true",
        "ConfigureUnit": "STR",
        "ConfigureName": "hbase#hbase-site.xml#hbase.exporter.enabled",
        "NeedRestart": "true",
        "RunningValue": "true"
      },
      {
        "ValueRange": "R[0,604800000]",
        "DefaultValue": "604800000",
        "Description": "The time (in miliseconds) between major compactions of all HStoreFiles in a region",
        "ConfigureUnit": "INT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.hregion.majorcompaction",
        "NeedRestart": "true",
        "RunningValue": "604800000"
      },
      {
        "ValueRange": "R[0.0,0.7]",
        "DefaultValue": "0.0",
        "Description": "Split the call queues into read and write queues. The specified interval (which should be between 0.0 and 1.0) will be multiplied by the number of call queues. A value of 0 indicate to not split the call queues, meaning that both read and write requests will be pushed to the same set of queues.",
        "ConfigureUnit": "FLOAT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.ipc.server.callqueue.read.ratio",
        "NeedRestart": "true",
        "RunningValue": "0.0"
      },
      {
        "ValueRange": "R[0.0,0.7]",
        "DefaultValue": "0.0",
        "Description": "Given the number of read call queues, calculated from the total number of call queues multiplied by the callqueue.read.ratio, the scan.ratio property will split the read call queues into small-read and long-read queues.",
        "ConfigureUnit": "FLOAT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.ipc.server.callqueue.scan.ratio",
        "NeedRestart": "true",
        "RunningValue": "0.0"
      },
      {
        "ValueRange": "R[0.24,0.475]|E[0.8*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}<=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]|E[0.95*${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}>=${hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit}]",
        "DefaultValue": "0.3",
        "Description": "Maximum size of all memstores in a region server before flushes are forced. Defaults to 95% of hbase.regionserver.global.memstore.size (0.95).",
        "ConfigureUnit": "FLOAT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.regionserver.global.memstore.lowerLimit",
        "NeedRestart": "true",
        "RunningValue": "0.3"
      },
      {
        "ValueRange": "R[0.3,0.5]|E[${hbase#hbase-site.xml#hfile.block.cache.size}+${hbase#hbase-site.xml#hbase.regionserver.global.memstore.size}<=0.8]",
        "DefaultValue": "0.35",
        "Description": "Maximum size of all memstores in a region server before new updates are blocked and flushes are forced",
        "ConfigureUnit": "FLOAT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.regionserver.global.memstore.size",
        "NeedRestart": "true",
        "RunningValue": "0.35"
      },
      {
        "ValueRange": "R[16,256]",
        "DefaultValue": "32",
        "Description": "If more than this many logs, force flush of oldest region to oldest edit goes to disk.",
        "ConfigureUnit": "INT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.regionserver.maxlogs",
        "NeedRestart": "true",
        "RunningValue": "32"
      },
      {
        "ValueRange": "R[1,10]",
        "DefaultValue": "1",
        "Description": "Large compaction threads",
        "ConfigureUnit": "INT",
        "ConfigureName": "hbase#hbase-site.xml#hbase.regionserver.thread.compaction.large",
        "NeedRestart": "false",
        "RunningValue": "1"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.