All Products
Search
Document Center

CloudOps Orchestration Service:UpdateSecretParameter

Last Updated:Oct 14, 2024

Updates an encryption parameter. Make sure that you have the permissions to call the UpdateSecretValue operation of Key Management Service (KMS) before you call this operation.

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:UpdateSecretParameterupdate
  • secretparameter
    acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
NamestringYes

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

MySecretParameter
ValuestringYes

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

update
DescriptionstringNo

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

SecretParameter
TagsobjectNo

The tags of the parameter.

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

The ID of the resource group.

rg-acfmxsn4m4******

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF
Parameterobject

The information about the parameter.

Typestring

The type of the parameter.

Secret
UpdatedDatestring

The time when the parameter was updated.

2020-09-01T09:33:11Z
UpdatedBystring

The user who updated the parameter.

root(130900000)
KeyIdstring

The ID of customer master key (CMK) of Key Management Service (KMS) that is used for encryption.

80e9409f-78fa-42ab-84bd-83f40c******
Tagsstring

The tags of the parameter.

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

The description of the parameter.

SecretParameter
Constraintsstring

The constraints of the parameter.

'{''AllowedValues":["secretparameter"],"AllowedPattern":".*","MinLength":0,"MaxLength":20}'
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxsn4m4******
CreatedBystring

The user who created the parameter.

root(130900000)
CreatedDatestring

The time when the parameter was created.

2020-09-01T09:30:36Z
ParameterVersioninteger

The version number of the parameter.

2
Namestring

The name of the parameter.

MyParameter
Idstring

The ID of the parameter.

p-0b0fff9919c946xxxxxx
ShareTypestring

The share type of the parameter.

Private

Examples

Sample success responses

JSONformat

{
  "RequestId": "0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF",
  "Parameter": {
    "Type": "Secret",
    "UpdatedDate": "2020-09-01T09:33:11Z",
    "UpdatedBy": "root(130900000)",
    "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
    "Tags": "{\"k1\": \"v1\", \"k2\": \"v2\"}",
    "Description": "SecretParameter",
    "Constraints": "'{''AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\".*\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T09:30:36Z",
    "ParameterVersion": 2,
    "Name": "MyParameter",
    "Id": "p-0b0fff9919c946xxxxxx",
    "ShareType": "Private"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history