All Products
Search
Document Center

CloudOps Orchestration Service:GetSecretParameters

Last Updated:Oct 14, 2024

Queries the information about one or more encryption parameters. Make sure that you have the permissions to call the GetSecretValue 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.

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:GetSecretParametersget
  • secretparameter
    acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
NamesstringYes

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

["secretParameter","secretParameter1"]
WithDecryptionbooleanNo

Specifies whether to decrypt the parameter value. Default value: false. Valid values:

  • true
  • false
false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

A5320F1D-92D9-44BB-A416-5FC525ED6D57
InvalidParametersarray

Invalid encryption parameter.

InvalidParameterstring

Invalid parameters.

[ "InvalidSecretParameter"]
Parametersarray<object>

The information about the encryption parameter.

Parameterobject
Typestring

The data type of the encryption parameter.

Secret
UpdatedDatestring

The time when the encryption parameter was updated.

2020-10-22T03:11:13Z
UpdatedBystring

The user who updated the encryption parameter.

root(130900000)
KeyIdstring

The ID of the key.

ssh-bp67acfmxazb4p****
Tagsobject

The tags.

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

The value of the encryption parameter.

secretParameter,secretParameter1
Descriptionstring

The description of the encryption parameter.

secretParameter
Constraintsstring

The constraints of the encryption parameter.

{\"AllowedValues\": [\"test\"]}
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxsn4m4******
CreatedBystring

The user who created the encryption parameter.

root(130900000)
CreatedDatestring

The time when the encryption parameter was created.

2020-10-22T03:11:13Z
ParameterVersioninteger

The version number of the encryption parameter.

1
Namestring

The name of the encryption parameter.

MySecretParameter
Idstring

The ID of the encryption parameter.

p-7cdc0000000000000000
ShareTypestring

The share type of the encryption parameter.

Private

Examples

Sample success responses

JSONformat

{
  "RequestId": "A5320F1D-92D9-44BB-A416-5FC525ED6D57",
  "InvalidParameters": [
    "[ \"InvalidSecretParameter\"]"
  ],
  "Parameters": [
    {
      "Type": "Secret",
      "UpdatedDate": "2020-10-22T03:11:13Z",
      "UpdatedBy": "root(130900000)",
      "KeyId": "ssh-bp67acfmxazb4p****",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      },
      "Value": "secretParameter,secretParameter1",
      "Description": "secretParameter",
      "Constraints": "{\\\"AllowedValues\\\": [\\\"test\\\"]}",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-22T03:11:13Z",
      "ParameterVersion": 1,
      "Name": "MySecretParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history