Queries the details of one or more common parameters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetParameters

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

Names String Yes ["parameter1","parameter2"]

The name of the common parameter. Multiple common parameters can form a JSON array in the format of ["xxxxxxxxx", "yyyyyyyyy", … "zzzzzzzzz"]. Each JSON array can contain a maximum of 10 common parameters. Multiple common parameters in the array are separated by commas (,).

RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
InvalidParameters List ["InvalidParameter"]

Invalid parameter.

Parameters Array of Parameter

The description of the common parameter.

Constraints String {\"MaxLength\": 2}

The constraints of the common parameter.

CreatedBy String root(130900000)

The user who created the common parameter.

CreatedDate String 2020-10-22T03:30:45Z

The time when the common parameter was created.

Description String parameter

The description of the common parameter.

Id String p-7cdc0000000000000000

The ID of the common parameter.

Name String MyParameter

The name of the common parameter.

ParameterVersion Integer 1

The version number of the common parameter.

ShareType String Private

The share type of the common parameter.

Type String StringList

The type of the common parameter.

UpdatedBy String root(130900000)

The user who updated the common parameter.

UpdatedDate String 2020-10-22T03:30:45Z

The time when the common parameter was updated.

Value String parameter,parameter1

The value of the common parameter.

RequestId String 2597E94B-5346-42D1-BB58-D3333EDD0975

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetParameters
&Names=["parameter1","parameter2"]
&<Common request parameters>

Sample success responses

XML format

<Parameters>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>StringList</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description>parameter</Description>
    <Constraints/>
    <UpdatedDate>2020-10-22T03:30:45Z</UpdatedDate>
    <ParameterVersion>2</ParameterVersion>
    <CreatedDate>2020-10-22T03:30:27Z</CreatedDate>
    <Value>parameter,parameter1</Value>
    <Id>p-7cdc0000000000000000</Id>
    <Name>MyParameter</Name>
    <ShareType>Private</ShareType>
</Parameters>
<RequestId>2597E94B-5346-42D1-BB58-D3333EDD0975</RequestId>
<InvalidParameters>InInvalidParameter</InvalidParameters>

JSON format

{
	"Parameters": [
		{
			"UpdatedBy": "root(130900000)",
			"Type": "StringList",
			"CreatedBy": "root(130900000)",
			"Description": "parameter",
			"Constraints": "",
			"UpdatedDate": "2020-10-22T03:30:45Z",
			"ParameterVersion": 2,
			"CreatedDate": "2020-10-22T03:30:27Z",
			"Value": "parameter,parameter1",
			"Id": "p-7cdc0000000000000000",
			"Name": "MyParameter",
			"ShareType": "Private"
		}
	],
	"RequestId": "2597E94B-5346-42D1-BB58-D3333EDD0975",
	"InvalidParameters": [
		"InInvalidParameter"
	]
}

Error codes

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