參數(shù)格式說(shuō)明
本文介紹了使用阿里云CLI時(shí),不同數(shù)據(jù)類(lèi)型字段需要遵循的格式要求。
對(duì)于API中不同數(shù)據(jù)類(lèi)型的字段,阿里云CLI遵循如下格式要求:
參數(shù)大小寫(xiě):由于API參數(shù)嚴(yán)格區(qū)分大小寫(xiě),阿里云CLI的參數(shù)輸入也嚴(yán)格區(qū)分大小寫(xiě)。
參數(shù)值大小寫(xiě):雖然部分參數(shù)值可以不區(qū)分大小寫(xiě),但為了保證統(tǒng)一的書(shū)寫(xiě)規(guī)范,建議您對(duì)參數(shù)值也嚴(yán)格區(qū)分大小寫(xiě)。
Integer類(lèi)型參數(shù)值的傳入:API文檔中標(biāo)注為Integer類(lèi)型的參數(shù),可直接傳入。
示例:
aliyun ecs DescribeImages --ImageName WindowsTest --Pagesize 10
String類(lèi)型參數(shù)值的傳入:API文檔中標(biāo)注為String類(lèi)型的參數(shù),如果參數(shù)值中沒(méi)有包含特殊字符,可直接傳入。否則需要用單引號(hào)或雙引號(hào)包含后再傳入,在Linux、macOS或Windows PowerShell中,使用單引號(hào)(' '),在Windows Shell中,使用雙引號(hào)(" ")。
示例:
無(wú)特殊字符:
aliyun ecs DescribeImages --ImageName WindowsTest
有特殊字符:
Windows:
aliyun ecs DescribeImages --ImageName "自定義鏡像_1-10.11.161.1"
Linux/macOS:
aliyun ecs DescribeImages --ImageName '藍(lán)屏windows-DB業(yè)務(wù)-10.173.161.26'
String類(lèi)型字符串列表值的傳入:API文檔中標(biāo)注為String類(lèi)型的參數(shù),如果支持多個(gè)值的列表(如ImageId列表),可將相應(yīng)的參數(shù)值串用半角逗號(hào)字符分隔后,再使用單引號(hào)或雙引號(hào)包含后傳入。
示例:
Windows:
aliyun ecs DescribeImages --ImageId "m-23e0oxmbv,m-23waejuy9"
Linux/macOS:
aliyun ecs DescribeImages --ImageId 'm-23e0oxmbv,m-23waejuy9'
String類(lèi)型JSON數(shù)組參數(shù)值的傳入:API文檔中標(biāo)注為String類(lèi)型的參數(shù),如果要求參數(shù)值是一個(gè)帶有格式的JSON Array,需要將所有值用單引號(hào)包括,中間用方括號(hào)包含、雙引號(hào)引用、逗號(hào)分隔。也可將上述用法中的單引號(hào)和雙引號(hào)互換。
示例:
Windows:
aliyun ecs DescribeDisks --DiskIds "['d-23rssg24f','d-23vsih26x','d-23sfqfbfa']"
Linux/macOS:
aliyun ecs DescribeDisks --DiskIds '["d-23rssg24f","d-23vsih26x","d-23sfqfbfa"]'
String類(lèi)型JSON數(shù)組列表參數(shù)值的傳入:API文檔中標(biāo)注為String類(lèi)型的參數(shù),如果要求參數(shù)值是一個(gè)JSON Array List,需要將所有值在最外層用雙引號(hào)包括,中間用方括號(hào)包含,JSON Array值用大括號(hào)包含、逗號(hào)分隔,JSON Array內(nèi)的key和value用冒號(hào)分隔。也可將上述用法中的單引號(hào)和雙引號(hào)互換。
示例:
Windows:
aliyun slb AddBackendServers --LoadBalancerId 15157b19f18-cn-hangzhou-dg-a01 --BackendServers "[{'ServerId':'i-23g8aact0'},{'ServerId':'i-23bb03yh9'}]"
Linux/macOS:
aliyun slb AddBackendServers --LoadBalancerId 15157b19f18-cn-hangzhou-dg-a01 --BackendServers '[{"ServerId":"i-23g8aact0"},{"ServerId":"i-23bb03yh9"}]'
String類(lèi)型日期格式參數(shù)值的傳入:API文檔中標(biāo)注為String類(lèi)型的參數(shù),如果要求參數(shù)值是一個(gè)按照ISO8601標(biāo)準(zhǔn)表示的UTC時(shí)間,需要將時(shí)間按YYYY-MM-DDThh:mm:ssZ格式傳入。
示例:
aliyun ecs DescribeInstanceMonitorData --InstanceId i-94ola4btx --StartTime 2015-11-28T15:00:00Z --EndTime 2015-11-28T18:00:00Z
特殊參數(shù)
當(dāng)您輸入的參數(shù)值包含特殊字符時(shí),執(zhí)行可能會(huì)存在解析錯(cuò)誤,這時(shí)候需要寫(xiě)成
key=value
的格式。例如:--PortRange -1/-1
改寫(xiě)成--PortRange=-1/-1
,則可以正確執(zhí)行。