All Products
Search
Document Center

Operation Orchestration Service:GetParameters

Last Updated:Oct 13, 2022

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:GetParametersREAD
  • OOS
    acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
NamesstringYes

The name of the common parameter. Multiple common parameters can form a JSON array in the format of ["xxxxxxxxx", "yyyyyyyyy", … "zzzzzzzzz"]. Each JSON array can contain a maximum of 10 common parameters. Multiple common parameters in the array are separated by commas (,).

["parameter1","parameter2"]

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2597E94B-5346-42D1-BB58-D3333EDD0975
InvalidParametersarray

Invalid parameter.

string

无效参数

["InvalidParameter"]
Parametersarray

The description of the common parameter.

object
Typestring

The type of the common parameter.

StringList
UpdatedDatestring

The time when the common parameter was updated.

2020-10-22T03:30:45Z
UpdatedBystring

The user who updated the common parameter.

root(130900000)
Tagsobject

标签

Valuestring

The value of the common parameter.

parameter,parameter1
Descriptionstring

The description of the common parameter.

parameter
Constraintsstring

The constraints of the common parameter.

{\"MaxLength\": 2}
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
CreatedBystring

The user who created the common parameter.

root(130900000)
CreatedDatestring

The time when the common parameter was created.

2020-10-22T03:30:45Z
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-7cdc0000000000000000
ShareTypestring

The share type of the common parameter.

Private

Example

Request example

http(s)://[Endpoint]/?Action=GetParameters
&RegionId=cn-hangzhou
&Names=["parameter1","parameter2"]
&Common request parameters

Normal return example

JSONFormat

{
    "Parameters": {
        "UpdatedBy": "root(130900000)",
        "Type": "StringList",
        "CreatedBy": "root(130900000)",
        "Description": "parameter",
        "Constraints": "",
        "UpdatedDate": "2020-10-22T03:30:45Z",
        "ParameterVersion": 2,
        "CreatedDate": "2020-10-22T03:30:27Z",
        "Value": "parameter,parameter1",
        "Id": "p-7cdc0000000000000000",
        "Name": "MyParameter",
        "Tags": {
            "k1": "v1",
            "k2": "v2"
        },
        "ResourceGroupId": "rg-acfmxsn4m4******",
        "ShareType": "Private"
    },
    "RequestId": "2597E94B-5346-42D1-BB58-D3333EDD0975",
    "InvalidParameters": "InInvalidParameter"
}

XMLFormat

<GetParametersResponse>
    <Parameters>
        <UpdatedBy>root(130900000)</UpdatedBy>
        <Type>StringList</Type>
        <CreatedBy>root(130900000)</CreatedBy>
        <Description>parameter</Description>
        <Constraints/>
        <UpdatedDate>2020-10-22T03:30:45Z</UpdatedDate>
        <ParameterVersion>2</ParameterVersion>
        <CreatedDate>2020-10-22T03:30:27Z</CreatedDate>
        <Value>parameter,parameter1</Value>
        <Id>p-7cdc0000000000000000</Id>
        <Name>MyParameter</Name>
        <Tags>
            <k1>v1</k1>
            <k2>v2</k2>
        </Tags>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <ShareType>Private</ShareType>
    </Parameters>
    <RequestId>2597E94B-5346-42D1-BB58-D3333EDD0975</RequestId>
    <InvalidParameters>InInvalidParameter</InvalidParameters>
</GetParametersResponse>

Error codes

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