Create an encryption parameter with CreateSecretParameter - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Creates an encrypted parameter. Make sure that you have the permission to call the KMS CreateSecret API operation before you call this operation.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:CreateSecretParameter

create

*secretparameter

acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Name	string	Yes	The parameter name. The name can contain letters, digits, hyphens (-), and underscores (_), and cannot exceed 180 characters in length. The name cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.	MySecretParameter
Type	string	No	The parameter type. Valid values: Secret.	Secret
Value	string	Yes	The parameter value. The value can be up to 4,096 characters in length.	SecretParameter
Description	string	No	The description of the parameter. The description can be up to 200 characters in length.	SecretParameter
KeyId	string	No	The ID of the KMS key used for encryption.	80e9409f-78fa-42ab-84bd-83f40c******
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be globally unique. The value can be up to 64 characters in length and can contain letters, digits, hyphens (-), and underscores (_). For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
Constraints	string	No	The constraints of the parameter. By default, this parameter is empty. Valid values: AllowedValues: the allowed values of the parameter. The value is a string of the array type. AllowedPattern: a regular expression string. MinLength: the minimum length of the parameter. MaxLength: the maximum length of the parameter.	'{''AllowedValues":["secretparameter"],"AllowedPattern":"secretparameter","MinLength":0,"MaxLength":20}'
Tags	object	No	The tags.	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	No	The resource group ID.	rg-acfmxsn4m4******
DKMSInstanceId	string	No	The instance ID of the KMS instance.	kst-hzz****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF
Parameter	object	The information about the encrypted parameter.
Type	string	The parameter type.	Secret
UpdatedDate	string	The time when the parameter was last updated. The time is in ISO 8601 format and in UTC.	2020-09-01T09:30:36Z
UpdatedBy	string	The user who last updated the parameter.	root(130900000)
KeyId	string	The ID of the KMS key used for encryption.	80e9409f-78fa-42ab-84bd-83f40c******
Tags	object	The tags.	{"k1": "v1", "k2": "v2"}
Description	string	The description of the parameter.	SecretParameter
Constraints	string	The constraints of the parameter.	'{ "AllowedValues": ["secretparameter"], "AllowedPattern": "secretparameter", "MinLength": 0, "MaxLength": 20 }'
ResourceGroupId	string	The resource group.	rg-acfmxsn4m4******
CreatedBy	string	The user who created the parameter.	root(130900000)
CreatedDate	string	The time when the parameter was created. The time is in ISO 8601 format and in UTC.	2020-09-01T09:30:36Z
ParameterVersion	integer	The version number of the parameter.	1
Name	string	The parameter name.	MyParameter
Id	string	The parameter ID.	p-0b0fff9919c946xxxxxx
ShareType	string	The share type of the parameter.	Private
DKMSInstanceId	string	The instance ID of the KMS instance.	kst-hzz****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.