DescribeInstanceConfigs-阿里云帮助中心

Queries instance configurations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /webapi/config/describeInstanceConfigs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	c-b25e21e24388****
ConfigType	string	No	The type of the configuration item. Valid values: FE BE CORE	FE
ConfigKey	string	No	The key of the configuration item.	enable_udf
Description	string	No	The description of the configuration item's feature.	是否开启 UDF。
AllowModify	boolean	No	Indicates whether the configuration item can be modified.	true
NeedTotal	boolean	No	Indicates whether to return all configuration items.	true
PageNumber	integer	No	The page number for the query. The default value is 1.	1
PageSize	integer	No	The number of entries per page for a paged query. The default value is 20.	10
NodeGroupId	string	No	The compute group ID.	ng-3d5ce6454354****

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP request status code.	200
RequestId	string	The request ID.	32A44F0D-BFF6-5664-999A-218BBDE7****
Success	boolean	Indicates whether the request was successful.	false
ErrCode	string	The error code.	InvalidParams
ErrMessage	string	The error message.	Invalid params: [instance not exists].
Total	integer	The total number of query results.	4
Data	array<object>	The returned data.
	object	The returned data.
ConfigType	string	The type of the configuration item. Valid values: FE BE CORE	FE
ConfigKey	string	The key of the configuration item.	enable_udf
DefaultValue	string	The default value of the configuration item.	true
ConfigValue	string	The value of the configuration item.	false
Restart	boolean	Indicates whether the instance needs to be restarted after the configuration item is changed. Valid values: true: Restart. false: Do not restart.	true
Unit	string	The unit of the configuration item. An empty string is returned if no unit is available.	s
ValueType	string	The data type of the configuration item's value.	INT
ValueRange	string	The value range of the configuration item. An empty string is returned if no value range is available.	true,false
AllowModify	string	Indicates whether the configuration item can be modified.	true
Description	string	The description of the configuration item's feature.	是否开启 UDF。
Custom	boolean	Indicates whether the item is a custom configuration.	false
NodeGroupId	string	The compute group ID.	ng-3d5ce6454354****
DefaultNodeGroup	boolean	Indicates whether it is the default compute group.	true
NodeGroupName	string	The name of the compute group.	ng_1
DescriptionEn	string	The English description of the configuration item.	A boolean value to control whether to enable the synchronization of the tablet metadata. true indicates enabling synchronization, and false indicates disabling it.
AccessDeniedDetail	string	The details of the access denied error.	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE7****",
  "Success": false,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Total": 4,
  "Data": [
    {
      "ConfigType": "FE",
      "ConfigKey": "enable_udf",
      "DefaultValue": "true",
      "ConfigValue": "false",
      "Restart": true,
      "Unit": "s",
      "ValueType": "INT",
      "ValueRange": "true,false",
      "AllowModify": "true",
      "Description": "是否开启 UDF。",
      "Custom": false,
      "NodeGroupId": "ng-3d5ce6454354****",
      "DefaultNodeGroup": true,
      "NodeGroupName": "ng_1",
      "DescriptionEn": "A boolean value to control whether to enable the synchronization of the tablet metadata. true indicates enabling synchronization, and false indicates disabling it."
    }
  ],
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxx\",     \"EncodedDiagnosticMessage\": \"xxx\",     \"AuthPrincipalType\": \"xxx\",     \"AuthPrincipalDisplayName\": \"xxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"sr:xxx\"   }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.