调用GetParametersByPath通过路径获取普通参数_系统运维管理(OOS)-阿里云帮助中心

通过路径获取参数。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oos:GetParametersByPath

get

*parameter

acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}

oos:TLSVersion

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
Path	string	是	参数路径，参数长度小于 200 个字符串。例如参数/parameter/myparameter，其中/parameter 为此参数的路径。	/parameter
Recursive	boolean	否	是否递归查询路径。如参数/parameter/myparameter 与/parameter/prameter1/myparameter，取值范围： true（搜索出/parameter/myparameter 与/parameter/prameter1/myparameter 两个结果） false（仅能搜索出/parameter/myparameter 这一个结果）	false
NextToken	string	否	翻页标记的 Token。	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzA
MaxResults	integer	否	分页大小。取值范围：1-10。默认为 10。	10

返回参数

名称	类型	描述	示例值
	object
NextToken	string	翻页标记的 Token	gAAAAABfTgv5ewUWmNdJ3g7JVLvX70sPH90GZOVGC
RequestId	string	请求 ID	25156E99-7437-4590-AA58-2ACA17DE405C
TotalCount	integer	查询到的参数总数。	1
MaxResults	integer	分页大小	10
Parameters	array<object>	参数信息
	object
Type	string	参数类型	StringList
UpdatedDate	string	参数更新时间	2020-10-21T04:03:12Z
UpdatedBy	string	参数更新者	root(130900000)
Value	string	参数内容	"parameter1,parameter2"
Description	string	参数的描述信息	parameter
Constraints	string	参数的约束条件	{\"MaxLength\": 2}
CreatedBy	string	参数创建者	root(130900000)
CreatedDate	string	参数创建时间	2020-10-21T04:03:12Z
ParameterVersion	integer	参数版本号	1
Name	string	参数名称	myParameter
Id	string	参数 ID	p-7cdc0000000000000000
ShareType	string	参数共享类型	Private
Tags	object	标签	{"k1": "v1", "k2": "v2"}

示例

正常返回示例

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",
      "Tags": {
        "k1": "v1",
        "k2": "v2"
      }
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。