SetLabel

API情報

API種別 Action 対象 名称 実行
設定 SetLabel 契約, VM, FW/LB ラベル設定  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象を含むgpサービスコード
ServiceCode

ラベルを設定するサービスコード

値: gp########, gc########, gl########のいずれか

参考: サービスコード

Label

設定するラベル

レスポンス

フィールド タイプ 意味
SetLabelResponse.GpServiceCode String 対象のgpサービスコード ※1
SetLabelResponse.GcServiceCode String 対象のgcサービスコード ※1
SetLabelResponse.GlServiceCode String 対象のglサービスコード ※1
SetLabelResponse.Label String 設定されたラベル

エラーコード

制限

サンプル

リクエスト

※実際には一行で現します
https://gp.api.iij.jp/json
    ?APIVersion=20130901
    &AccessKeyId=XXXXXXXXXXXXXXXXXXXX
    &Action=SetLabel
    &Expire=2013-09-01T10%3A10%3A30Z
    &GpServiceCode=gp########
    &Label=XXXXX
    &ServiceCode=gc########
    &SignatureMethod=HmacSHA256
    &SignatureVersion=2
    &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

レスポンス (JSON)

Json
{
    "SetLabelResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GpServiceCode": "gp########",
        "Label": "XXXXX"
    }
}
Json
{
    "SetLabelResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GcServiceCode": "gc########",
        "Label": "XXXXX"
    }
}
Json
{
    "SetLabelResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GlServiceCode": "gl########",
        "Label": "XXXXX"
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<SetLabelResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GpServiceCode>gp########</GpServiceCode>
  <Label>XXXXX</Label>
</SetLabelResponse>
XML
<?xml version="1.0" encoding="UTF-8"?>
<SetLabelResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GcServiceCode>gc########</GcServiceCode>
  <Label>XXXXX</Label>
</SetLabelResponse>
XML
<?xml version="1.0" encoding="UTF-8"?>
<SetLabelResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GlServiceCode>gl########</GlServiceCode>
  <Label>XXXXX</Label>
</SetLabelResponse>