All Products
Search

This Product

    CloudOps Orchestration Service:UpdateParameter

    Document Center

    CloudOps Orchestration Service:UpdateParameter

    Last Updated:Oct 14, 2024

    Updates a common parameter.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    oos:UpdateParameterupdate
    • parameter
      acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region ID.

    		cn-hangzhou
    NamestringYes

    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.

    		MyParameter
    ValuestringYes

    The value of the common parameter. The value must be 1 to 4,096 characters in length.

    		update
    DescriptionstringNo

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

    		update
    TagsstringNo

    The tags to be added to common parameter.

    		{"k1": "v1", "k2": "v2"}
    ResourceGroupIdstringNo

    The resource group ID.

    		rg-acfmxsn4m4******

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		AF1AE6DE-61C4-435E-8687-072CFACCCEC7
    Parameterobject

    The information about the common parameter.

    Typestring

    The data type of the common parameter.

    		String
    UpdatedDatestring

    The time when the common parameter was updated.

    		2020-09-01T08:04:23Z
    UpdatedBystring

    The user who updated the common parameter.

    		root(130900000)
    Tagsstring

    The tag added to the common parameter.

    		{"k1": "v1", "k2": "v2"}
    Descriptionstring

    The description of the common parameter.

    		update
    Constraintsstring

    The constraints of the common parameter.

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

    The resource group ID.

    		rg-acfmxsn4m4******
    CreatedBystring

    The user who created the common parameter.

    		root(130900000)
    CreatedDatestring

    The time when the common parameter was created.

    		2020-09-01T08:01:43Z
    ParameterVersioninteger

    The version number of the common parameter.

    		2
    Namestring

    The name of the common parameter.

    		MyParameter
    Idstring

    The parameter ID.

    		p-4c4b401cab6747xxxxxx
    ShareTypestring

    The share type of the common parameter.

    		Private

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "AF1AE6DE-61C4-435E-8687-072CFACCCEC7",
  "Parameter": {
    "Type": "String",
    "UpdatedDate": "2020-09-01T08:04:23Z",
    "UpdatedBy": "root(130900000)",
    "Tags": "{\"k1\": \"v1\", \"k2\": \"v2\"}",
    "Description": "update",
    "Constraints": "\"{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}\"",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T08:01:43Z",
    "ParameterVersion": 2,
    "Name": "MyParameter",
    "Id": "p-4c4b401cab6747xxxxxx",
    "ShareType": "Private"
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history