全部产品
Search
文档中心

运维编排服务:GetParametersByPath - 通过路径获取普通参数

更新时间:Dec 07, 2022

通过路径获取普通参数。

调试

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

调试

授权信息

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

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

请求参数

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

地域ID。

cn-hangzhou
Pathstring

参数路径,参数长度小于200个字符串。例如参数/parameter/myparameter,其中/parameter为此参数的路径。

/parameter
Recursiveboolean

是否递归查询路径。如参数/parameter/myparameter与/parameter/prameter1/myparameter,取值范围:

  • true(搜索出/parameter/myparameter与/parameter/prameter1/myparameter两个结果)
  • false(仅能搜索出/parameter/myparameter这一个结果)
false
NextTokenstring

翻页标记的Token。

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
MaxResultsinteger

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

10

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的Token

gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestIdstring

请求ID

25156E99-7437-4590-AA58-2ACA17DE405C
TotalCountinteger

查询到的参数总数。

1
MaxResultsinteger

分页大小

10
Parametersarray

参数信息

object
Typestring

参数类型

StringList
UpdatedDatestring

参数更新时间

2020-10-21T04:03:12Z
UpdatedBystring

参数更新者

root(130900000)
Valuestring

参数内容

"parameter1,parameter2"
Descriptionstring

参数的描述信息

parameter
Constraintsstring

参数的约束条件

{\"MaxLength\": 2}
CreatedBystring

参数创建者

root(130900000)
CreatedDatestring

参数创建时间

2020-10-21T04:03:12Z
ParameterVersioninteger

参数版本号

1
Namestring

参数名称

myParameter
Idstring

参数ID

p-7cdc0000000000000000
ShareTypestring

参数共享类型

Private

示例

正常返回示例

JSON格式

{
  "NextToken": "gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC",
  "RequestId": "25156E99-7437-4590-AA58-2ACA17DE405C",
  "TotalCount": 1,
  "MaxResults": 10,
  "Parameters": [
    {
      "Type": "StringList",
      "UpdatedDate": "2020-10-21T04:03:12Z",
      "UpdatedBy": "root(130900000)",
      "Value": "\"parameter1,parameter2\"",
      "Description": "parameter",
      "Constraints": "{\\\"MaxLength\\\": 2}",
      "CreatedBy": "root(130900000)",
      "CreatedDate": "2020-10-21T04:03:12Z",
      "ParameterVersion": 1,
      "Name": "myParameter",
      "Id": "p-7cdc0000000000000000",
      "ShareType": "Private"
    }
  ]
}

错误码

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