All Products
Search
Document Center

Operation Orchestration Service:CreateParameter

Last Updated:Nov 11, 2022

Creates a common parameter.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
oos:CreateParameterWRITE
  • OOS
    acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the resource.

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
TypestringYes

The data type of the common parameter. Valid values: String and StringList.

String
ValuestringYes

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

parameter
DescriptionstringNo

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

parameter
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. The token is a unique string that is generated by the client.

The token must be 1 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****
ConstraintsstringNo

The constraints of the common parameter. By default, this parameter is null. Valid values:

  • AllowedValues: The value that is allowed for the common parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the common parameter. It must be a regular expression.
  • MinLength: The minimum length of the common parameter.
  • MaxLength: The maximum length of the common parameter.
'{''AllowedValues":["parameter"],"AllowedPattern":"parameter","MinLength":0,"MaxLength":20}'
TagsobjectNo

The tags.

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 of the common parameter.

Typestring

The type of the common parameter.

String
UpdatedDatestring

The time when the common parameter was updated.

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

The user who updated the common parameter.

root(130900000)
Tagsobject

The tags.

Descriptionstring

The description of the common parameter.

parameter
Constraintsstring

The constraints of the common parameter.

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

The ID of resource group.

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.

1
Namestring

The name of the common parameter.

MyParameter
Idstring

The ID of the common parameter.

p-4c4b401cab6747xxxxxx
ShareTypestring

The share type of the common parameter.

Private

Example

Normal return example

JSONFormat

{
    "RequestId": "0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF",
    "Parameter": {
        "Type": "String",
        "UpdatedDate": "2020-09-01T08:01:43Z",
        "UpdatedBy": "root(130900000)",
        "Description": "parameter",
        "Constraints": "\"{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}\"",
        "ResourceGroupId": "rg-acfmxsn4m4******",
        "CreatedBy": "root(130900000)",
        "CreatedDate": "2020-09-01T08:01:43Z",
        "ParameterVersion": 1,
        "Name": "MyParameter",
        "Id": "p-4c4b401cab6747xxxxxx",
        "Tags": {
            "k1": "v1",
            "k2": "v2"
        },
        "ShareType": "Private"
    }
}

XMLFormat

<CreateParameterResponse>
    <RequestId>0B419FF3-ABC6-4DF0-95E5-636DC8CBB8AF</RequestId>
    <Parameter>
        <Type>String</Type>
        <UpdatedDate>2020-09-01T08:01:43Z</UpdatedDate>
        <UpdatedBy>root(130900000)</UpdatedBy>
        <Description>parameter</Description>
        <Constraints>"{'AllowedValues':['parameter'],'AllowedPattern':'parameter','MinLength':0,'MaxLength':20}"</Constraints>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <CreatedBy>root(130900000)</CreatedBy>
        <CreatedDate>2020-09-01T08:01:43Z</CreatedDate>
        <ParameterVersion>1</ParameterVersion>
        <Name>MyParameter</Name>
        <Id>p-4c4b401cab6747xxxxxx</Id>
        <Tags>
            <k1>v1</k1>
            <k2>v2</k2>
        </Tags>
        <ShareType>Private</ShareType>
    </Parameter>
</CreateParameterResponse>

Error codes

For a list of error codes, visit the API error center.