All Products
Search
Document Center

CloudOps Orchestration Service:GetParameter

Last Updated:Oct 14, 2024

Queries a common parameter and its value.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
NamestringYes

The name of the common parameter. The name can be up to 200 characters in length and can contain letters, digits, hyphens (-), and underscores (_).

MyParameter
ParameterVersionintegerNo

The version number of the common parameter. Valid values: 1 to 100.

1
ResourceGroupIdstringNo

The resource group ID.

rg-acfmxsn4m*****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

BA326372-2A10-4C3B-BE3E-6439DB7557CC
Parameterobject

The information about the common parameter.

Typestring

The data 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 added to the common parameter.

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

The value of the common parameter.

parameter
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 resource group ID.

rg-acfmxsn4m*****
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

Examples

Sample success responses

JSONformat

{
  "RequestId": "BA326372-2A10-4C3B-BE3E-6439DB7557CC",
  "Parameter": {
    "Type": "String",
    "UpdatedDate": "2020-09-01T08:01:43Z",
    "UpdatedBy": "root(130900000)",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Value": "parameter",
    "Description": "parameter",
    "Constraints": "'{''AllowedValues\":[\"parameter\"],\"AllowedPattern\":\"parameter\",\"MinLength\":0,\"MaxLength\":20}'",
    "ResourceGroupId": "rg-acfmxsn4m*****",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2020-09-01T08:01:43Z",
    "ParameterVersion": 1,
    "Name": "MyParameter",
    "Id": "p-4c4b401cab6747xxxxxx",
    "ShareType": "Private"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history