CreateSecretParameter - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Creates an encryption parameter. Make sure that you have the permissions to call the CreateSecret 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
oos:CreateSecretParameter	create	secretparameter acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
Name	string	Yes	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
Type	string	No	The type of the parameter. Set the value to Secret.	Secret
Value	string	Yes	The value of the encryption parameter. The value must be 1 to 4096 characters in length.	SecretParameter
Description	string	No	The description of the encryption parameter. The description must be 1 to 200 characters in length.	SecretParameter
KeyId	string	No	The key ID of Key Management Service (KMS) that is used to encrypt the parameter.	80e9409f-78fa-42ab-84bd-83f40c******
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token 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 encryption parameter. By default, this parameter is null. Valid values: AllowedValues: The value that is allowed for the encryption parameter. It must be an array string. AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression. MinLength: The minimum length of the encryption parameter. MaxLength: The maximum length of the encryption parameter.	'{''AllowedValues":["secretparameter"],"AllowedPattern":"secretparameter","MinLength":0,"MaxLength":20}'
Tags	object	No	The tags.	{"k1": "v1", "k2": "v2"}
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxsn4m4******
DKMSInstanceId	string	No	The instance ID of the KMS instance.	kst-hzz****

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation
2024-04-18	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-10-10	The internal configuration of the API is changed, but the call is not affected	View Change Details