Updates a common parameter.

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 a sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateParameter

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

Name String Yes MyParameter

The name of the common parameter. The name must be 1 to 200 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.

Value String Yes update

The value of the common parameter. The value must be 1 to 4096 characters in length.

RegionId String No cn-hangzhou

The region ID of the resource.

Description String No update

The description of the common parameter. The description must be 1 to 200 characters in length.

Response parameters

Parameter Type Example Description
Parameter Struct

The information of the common parameter.

Constraints String "{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}"

The constraints of the common parameter.

CreatedBy String root(130900000)

The user who created the common parameter.

CreatedDate String 2020-09-01T08:01:43Z

The time when the common parameter was created.

Description String update

The description of the common parameter.

Id String p-4c4b401cab6747xxxxxx

The ID of the common parameter.

Name String MyParameter

The name of the common parameter.

ParameterVersion Integer 2

The version number of the common parameter.

ShareType String Private

The share type of the common parameter.

Type String String

The data type of the common parameter.

UpdatedBy String root(130900000)

The user who updated the common parameter.

UpdatedDate String 2020-09-01T08:04:23Z

The time when the common parameter was updated.

RequestId String AF1AE6DE-61C4-435E-8687-072CFACCCEC7

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=UpdateParameter
&Name=MyParameter
&Value=update
&<Common request parameters>

Sample success responses

XML format

<RequestId>AF1AE6DE-61C4-435E-8687-072CFACCCEC7</RequestId>
<Parameter>
    <UpdatedBy>root(130900000)</UpdatedBy>
    <Type>String</Type>
    <CreatedBy>root(130900000)</CreatedBy>
    <Description>update</Description>
    <UpdatedDate>2020-09-01T09:14:34Z</UpdatedDate>
    <ParameterVersion>2</ParameterVersion>
    <CreatedDate>2020-09-01T07:18:32Z</CreatedDate>
    <Id>p-ac86d11d9c6d48xxxxxx</Id>
    <Name>MyParameter</Name>
    <ShareType>Private</ShareType>
    <Constraints>{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}</Constraints>
</Parameter>

JSON format

{
	"RequestId": "AF1AE6DE-61C4-435E-8687-072CFACCCEC7",
	"Parameter": {
		"UpdatedBy": "root(130900000)",
		"Type": "String",
		"CreatedBy": "root(130900000)",
		"Description": "update",
		"UpdatedDate": "2020-09-01T09:14:34Z",
		"ParameterVersion": 2,
		"CreatedDate": "2020-09-01T07:18:32Z",
		"Id": "p-ac86d11d9c6d48xxxxxx",
		"Name": "MyParameter",
		"ShareType": "Private",
        "Constraints":"{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}"
	}
}

Error codes

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