全部产品
Search
文档中心

运维编排服务:ListSecretParameters - 获取 Secret 参数列表

更新时间:Oct 13, 2022

调用ListSecretParameters查询普通参数,支持多种查询。

接口说明

请确保在使用该接口前有操作KMS secret对应权限,

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:ListSecretParametersLIST
  • OOS
    acs:oos:{#regionId}:{#accountId}:secretparameter/*

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
Namestring

参数名称。本Action下的Name为模糊匹配。

MySecretParameter
MaxResultsinteger

分页大小。取值范围:10-100。默认为50。

50
NextTokenstring

翻页标记的Token

sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA
SortFieldstring

根据字段排序。取值范围:

  • Name(参数名称)

  • CreatedDate(创建时间)

Name
SortOrderstring

排序顺序。取值范围:

  • Ascending(升序)

  • Descending(默认值):降序

Descending
Pathstring

参数路径。例如:Name为/path/path1/Myparameter 此时包含参数路径。

/path1/path2/
Recursiveboolean

参数路径是否递归。 默认:false

false
Tagsobject

标签。

ResourceGroupIdstring

资源组ID。

rg-acfmxsn4m4******

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的Token

sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA
RequestIdstring

请求ID。

CA9C6248-AF2A-4AE9-A166-88FD901BBB90
MaxResultsinteger

分页大小

50
Parametersarray

加密参数信息

object
Typestring

参数类型

Secret
UpdatedDatestring

参数更新时间

2020-09-01T09:35:17Z
UpdatedBystring

参数更新者

root(130900000)
KeyIdstring

加密使用的KMS的KeyId

80e9409f-78fa-42ab-84bd-83f40c******
Tagsobject

标签

Descriptionstring

参数描述信息

SecretParameter
ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
CreatedBystring

参数创建者

root(130900000)
CreatedDatestring

参数创建时间

2020-09-01T09:28:47Z
ParameterVersionstring

参数版本

1
Namestring

参数名称

MySecretParameter
Idstring

加密参数Id

p-14ed150fdcd048xxxxxx
ShareTypestring

参数共享类型

Private

示例

请求示例

http(s)://[Endpoint]/?Action=ListSecretParameters
&RegionId=cn-hangzhou
&Name=MySecretParameter
&MaxResults=50
&NextToken=sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA
&SortField=Name
&SortOrder=Descending
&Path=/path1/path2/
&Recursive=false
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

JSON格式

{
    "NextToken": "sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA",
    "RequestId": "CA9C6248-AF2A-4AE9-A166-88FD901BBB90",
    "MaxResults": 50,
    "Parameters": {
        "Type": "Secret",
        "UpdatedDate": "2020-09-01T09:35:17Z",
        "UpdatedBy": "root(130900000)",
        "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******",
        "Description": "SecretParameter",
        "ResourceGroupId": "rg-acfmxsn4m4******",
        "CreatedBy": "root(130900000)",
        "CreatedDate": "2020-09-01T09:28:47Z",
        "ParameterVersion": 1,
        "Name": "MySecretParameter",
        "Id": "p-14ed150fdcd048xxxxxx",
        "Tags": {
            "k1": "v1",
            "k2": "v2"
        },
        "ShareType": "Private"
    }
}

XML格式

<ListSecretParametersResponse>
    <NextToken>sPH90GZOVGC6KPDUL0FIIbEtMQHq_19S6_4O_XqA</NextToken>
    <RequestId>CA9C6248-AF2A-4AE9-A166-88FD901BBB90</RequestId>
    <MaxResults>50</MaxResults>
    <Parameters>
        <Type>Secret</Type>
        <UpdatedDate>2020-09-01T09:35:17Z</UpdatedDate>
        <UpdatedBy>root(130900000)</UpdatedBy>
        <KeyId>80e9409f-78fa-42ab-84bd-83f40c******</KeyId>
        <Description>SecretParameter</Description>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <CreatedBy>root(130900000)</CreatedBy>
        <CreatedDate>2020-09-01T09:28:47Z</CreatedDate>
        <ParameterVersion>1</ParameterVersion>
        <Name>MySecretParameter</Name>
        <Id>p-14ed150fdcd048xxxxxx</Id>
        <Tags>
            <k1>v1</k1>
            <k2>v2</k2>
        </Tags>
        <ShareType>Private</ShareType>
    </Parameters>
</ListSecretParametersResponse>

错误码

访问错误中心查看更多错误码。